├── .travis.yml
├── LICENSE
├── README.md
├── TODO.txt
├── client
├── Makefile
├── config.yaml.in
└── git-simpleserver
├── server
├── Makefile
├── authorized_keys
├── git-shell-commands
│ ├── no-interactive-login
│ ├── repo-access
│ ├── repo-create
│ ├── repo-delete
│ ├── repo-info
│ ├── repo-list
│ ├── user-create
│ ├── user-delete
│ ├── user-info
│ └── user-list
└── shell
└── tests
├── 01-repo.test
├── 02-user.test
├── 03-cleanup.test
├── common-repo.sh
├── common-user.sh
├── common.sh
└── run.sh
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: shell
2 |
3 | before_install:
4 | - sudo apt-get update
5 |
6 | # SSH stuff, so we can ssh into localhost
7 | - ssh-keyscan localhost >> $HOME/.ssh/known_hosts
8 | - ssh-keygen -f $HOME/.ssh/id_rsa -N ''
9 |
10 | install:
11 | - sudo apt-get install git ssh sed grep gawk
12 |
13 | - sudo cp -R $(pwd) /usr/local/etc/git-simpleserver
14 | - cd /usr/local/etc/git-simpleserver/server
15 | - GIT_USER="$(whoami)" NON_INTERACTIVE=true sudo make install
16 | - cd ../client
17 | - make config
18 | - sudo make install
19 | - cd ..
20 |
21 | before_script:
22 | # Set up SSH for git-simpleserver
23 | - echo "PermitUserEnvironment yes" | sudo tee -a /etc/ssh/sshd_config > /dev/null
24 | # For some reason including any of the other settings prevents sshd from restarting :(
25 | - sudo /etc/init.d/ssh reload
26 |
27 | # Patch out version check. TODO(leon): This is terrible!
28 | - sudo sed -i "s/DO_REQUIRE_VERSION=true/DO_REQUIRE_VERSION=false/" /usr/local/etc/git-simpleserver/server/shell
29 |
30 | # Add our ssh public key to git's authorized_keys file
31 | - PUBLIC_KEY=$(cat $HOME/.ssh/id_rsa.pub)
32 | - sudo sed -i "s|your-ssh-public-key|$PUBLIC_KEY|" /home/git/.ssh/authorized_keys
33 |
34 | # Set ssh server to use
35 | - sed -i "s/ssh_server:.*/ssh_server:localhost/" $HOME/.git-simpleserver/config.yaml
36 |
37 | script:
38 | - ./tests/run.sh --i-know-what-im-doing
39 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 |
2 | GNU AFFERO GENERAL PUBLIC LICENSE
3 | Version 3, 19 November 2007
4 |
5 | Copyright (C) 2007 Free Software Foundation, Inc.
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The GNU Affero General Public License is a free, copyleft license for
12 | software and other kinds of works, specifically designed to ensure
13 | cooperation with the community in the case of network server software.
14 |
15 | The licenses for most software and other practical works are designed
16 | to take away your freedom to share and change the works. By contrast,
17 | our General Public Licenses are intended to guarantee your freedom to
18 | share and change all versions of a program--to make sure it remains free
19 | software for all its users.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | them if you wish), that you receive source code or can get it if you
25 | want it, that you can change the software or use pieces of it in new
26 | free programs, and that you know you can do these things.
27 |
28 | Developers that use our General Public Licenses protect your rights
29 | with two steps: (1) assert copyright on the software, and (2) offer
30 | you this License which gives you legal permission to copy, distribute
31 | and/or modify the software.
32 |
33 | A secondary benefit of defending all users' freedom is that
34 | improvements made in alternate versions of the program, if they
35 | receive widespread use, become available for other developers to
36 | incorporate. Many developers of free software are heartened and
37 | encouraged by the resulting cooperation. However, in the case of
38 | software used on network servers, this result may fail to come about.
39 | The GNU General Public License permits making a modified version and
40 | letting the public access it on a server without ever releasing its
41 | source code to the public.
42 |
43 | The GNU Affero General Public License is designed specifically to
44 | ensure that, in such cases, the modified source code becomes available
45 | to the community. It requires the operator of a network server to
46 | provide the source code of the modified version running there to the
47 | users of that server. Therefore, public use of a modified version, on
48 | a publicly accessible server, gives the public access to the source
49 | code of the modified version.
50 |
51 | An older license, called the Affero General Public License and
52 | published by Affero, was designed to accomplish similar goals. This is
53 | a different license, not a version of the Affero GPL, but Affero has
54 | released a new version of the Affero GPL which permits relicensing under
55 | this license.
56 |
57 | The precise terms and conditions for copying, distribution and
58 | modification follow.
59 |
60 | TERMS AND CONDITIONS
61 |
62 | 0. Definitions.
63 |
64 | "This License" refers to version 3 of the GNU Affero General Public License.
65 |
66 | "Copyright" also means copyright-like laws that apply to other kinds of
67 | works, such as semiconductor masks.
68 |
69 | "The Program" refers to any copyrightable work licensed under this
70 | License. Each licensee is addressed as "you". "Licensees" and
71 | "recipients" may be individuals or organizations.
72 |
73 | To "modify" a work means to copy from or adapt all or part of the work
74 | in a fashion requiring copyright permission, other than the making of an
75 | exact copy. The resulting work is called a "modified version" of the
76 | earlier work or a work "based on" the earlier work.
77 |
78 | A "covered work" means either the unmodified Program or a work based
79 | on the Program.
80 |
81 | To "propagate" a work means to do anything with it that, without
82 | permission, would make you directly or secondarily liable for
83 | infringement under applicable copyright law, except executing it on a
84 | computer or modifying a private copy. Propagation includes copying,
85 | distribution (with or without modification), making available to the
86 | public, and in some countries other activities as well.
87 |
88 | To "convey" a work means any kind of propagation that enables other
89 | parties to make or receive copies. Mere interaction with a user through
90 | a computer network, with no transfer of a copy, is not conveying.
91 |
92 | An interactive user interface displays "Appropriate Legal Notices"
93 | to the extent that it includes a convenient and prominently visible
94 | feature that (1) displays an appropriate copyright notice, and (2)
95 | tells the user that there is no warranty for the work (except to the
96 | extent that warranties are provided), that licensees may convey the
97 | work under this License, and how to view a copy of this License. If
98 | the interface presents a list of user commands or options, such as a
99 | menu, a prominent item in the list meets this criterion.
100 |
101 | 1. Source Code.
102 |
103 | The "source code" for a work means the preferred form of the work
104 | for making modifications to it. "Object code" means any non-source
105 | form of a work.
106 |
107 | A "Standard Interface" means an interface that either is an official
108 | standard defined by a recognized standards body, or, in the case of
109 | interfaces specified for a particular programming language, one that
110 | is widely used among developers working in that language.
111 |
112 | The "System Libraries" of an executable work include anything, other
113 | than the work as a whole, that (a) is included in the normal form of
114 | packaging a Major Component, but which is not part of that Major
115 | Component, and (b) serves only to enable use of the work with that
116 | Major Component, or to implement a Standard Interface for which an
117 | implementation is available to the public in source code form. A
118 | "Major Component", in this context, means a major essential component
119 | (kernel, window system, and so on) of the specific operating system
120 | (if any) on which the executable work runs, or a compiler used to
121 | produce the work, or an object code interpreter used to run it.
122 |
123 | The "Corresponding Source" for a work in object code form means all
124 | the source code needed to generate, install, and (for an executable
125 | work) run the object code and to modify the work, including scripts to
126 | control those activities. However, it does not include the work's
127 | System Libraries, or general-purpose tools or generally available free
128 | programs which are used unmodified in performing those activities but
129 | which are not part of the work. For example, Corresponding Source
130 | includes interface definition files associated with source files for
131 | the work, and the source code for shared libraries and dynamically
132 | linked subprograms that the work is specifically designed to require,
133 | such as by intimate data communication or control flow between those
134 | subprograms and other parts of the work.
135 |
136 | The Corresponding Source need not include anything that users
137 | can regenerate automatically from other parts of the Corresponding
138 | Source.
139 |
140 | The Corresponding Source for a work in source code form is that
141 | same work.
142 |
143 | 2. Basic Permissions.
144 |
145 | All rights granted under this License are granted for the term of
146 | copyright on the Program, and are irrevocable provided the stated
147 | conditions are met. This License explicitly affirms your unlimited
148 | permission to run the unmodified Program. The output from running a
149 | covered work is covered by this License only if the output, given its
150 | content, constitutes a covered work. This License acknowledges your
151 | rights of fair use or other equivalent, as provided by copyright law.
152 |
153 | You may make, run and propagate covered works that you do not
154 | convey, without conditions so long as your license otherwise remains
155 | in force. You may convey covered works to others for the sole purpose
156 | of having them make modifications exclusively for you, or provide you
157 | with facilities for running those works, provided that you comply with
158 | the terms of this License in conveying all material for which you do
159 | not control copyright. Those thus making or running the covered works
160 | for you must do so exclusively on your behalf, under your direction
161 | and control, on terms that prohibit them from making any copies of
162 | your copyrighted material outside their relationship with you.
163 |
164 | Conveying under any other circumstances is permitted solely under
165 | the conditions stated below. Sublicensing is not allowed; section 10
166 | makes it unnecessary.
167 |
168 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
169 |
170 | No covered work shall be deemed part of an effective technological
171 | measure under any applicable law fulfilling obligations under article
172 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
173 | similar laws prohibiting or restricting circumvention of such
174 | measures.
175 |
176 | When you convey a covered work, you waive any legal power to forbid
177 | circumvention of technological measures to the extent such circumvention
178 | is effected by exercising rights under this License with respect to
179 | the covered work, and you disclaim any intention to limit operation or
180 | modification of the work as a means of enforcing, against the work's
181 | users, your or third parties' legal rights to forbid circumvention of
182 | technological measures.
183 |
184 | 4. Conveying Verbatim Copies.
185 |
186 | You may convey verbatim copies of the Program's source code as you
187 | receive it, in any medium, provided that you conspicuously and
188 | appropriately publish on each copy an appropriate copyright notice;
189 | keep intact all notices stating that this License and any
190 | non-permissive terms added in accord with section 7 apply to the code;
191 | keep intact all notices of the absence of any warranty; and give all
192 | recipients a copy of this License along with the Program.
193 |
194 | You may charge any price or no price for each copy that you convey,
195 | and you may offer support or warranty protection for a fee.
196 |
197 | 5. Conveying Modified Source Versions.
198 |
199 | You may convey a work based on the Program, or the modifications to
200 | produce it from the Program, in the form of source code under the
201 | terms of section 4, provided that you also meet all of these conditions:
202 |
203 | a) The work must carry prominent notices stating that you modified
204 | it, and giving a relevant date.
205 |
206 | b) The work must carry prominent notices stating that it is
207 | released under this License and any conditions added under section
208 | 7. This requirement modifies the requirement in section 4 to
209 | "keep intact all notices".
210 |
211 | c) You must license the entire work, as a whole, under this
212 | License to anyone who comes into possession of a copy. This
213 | License will therefore apply, along with any applicable section 7
214 | additional terms, to the whole of the work, and all its parts,
215 | regardless of how they are packaged. This License gives no
216 | permission to license the work in any other way, but it does not
217 | invalidate such permission if you have separately received it.
218 |
219 | d) If the work has interactive user interfaces, each must display
220 | Appropriate Legal Notices; however, if the Program has interactive
221 | interfaces that do not display Appropriate Legal Notices, your
222 | work need not make them do so.
223 |
224 | A compilation of a covered work with other separate and independent
225 | works, which are not by their nature extensions of the covered work,
226 | and which are not combined with it such as to form a larger program,
227 | in or on a volume of a storage or distribution medium, is called an
228 | "aggregate" if the compilation and its resulting copyright are not
229 | used to limit the access or legal rights of the compilation's users
230 | beyond what the individual works permit. Inclusion of a covered work
231 | in an aggregate does not cause this License to apply to the other
232 | parts of the aggregate.
233 |
234 | 6. Conveying Non-Source Forms.
235 |
236 | You may convey a covered work in object code form under the terms
237 | of sections 4 and 5, provided that you also convey the
238 | machine-readable Corresponding Source under the terms of this License,
239 | in one of these ways:
240 |
241 | a) Convey the object code in, or embodied in, a physical product
242 | (including a physical distribution medium), accompanied by the
243 | Corresponding Source fixed on a durable physical medium
244 | customarily used for software interchange.
245 |
246 | b) Convey the object code in, or embodied in, a physical product
247 | (including a physical distribution medium), accompanied by a
248 | written offer, valid for at least three years and valid for as
249 | long as you offer spare parts or customer support for that product
250 | model, to give anyone who possesses the object code either (1) a
251 | copy of the Corresponding Source for all the software in the
252 | product that is covered by this License, on a durable physical
253 | medium customarily used for software interchange, for a price no
254 | more than your reasonable cost of physically performing this
255 | conveying of source, or (2) access to copy the
256 | Corresponding Source from a network server at no charge.
257 |
258 | c) Convey individual copies of the object code with a copy of the
259 | written offer to provide the Corresponding Source. This
260 | alternative is allowed only occasionally and noncommercially, and
261 | only if you received the object code with such an offer, in accord
262 | with subsection 6b.
263 |
264 | d) Convey the object code by offering access from a designated
265 | place (gratis or for a charge), and offer equivalent access to the
266 | Corresponding Source in the same way through the same place at no
267 | further charge. You need not require recipients to copy the
268 | Corresponding Source along with the object code. If the place to
269 | copy the object code is a network server, the Corresponding Source
270 | may be on a different server (operated by you or a third party)
271 | that supports equivalent copying facilities, provided you maintain
272 | clear directions next to the object code saying where to find the
273 | Corresponding Source. Regardless of what server hosts the
274 | Corresponding Source, you remain obligated to ensure that it is
275 | available for as long as needed to satisfy these requirements.
276 |
277 | e) Convey the object code using peer-to-peer transmission, provided
278 | you inform other peers where the object code and Corresponding
279 | Source of the work are being offered to the general public at no
280 | charge under subsection 6d.
281 |
282 | A separable portion of the object code, whose source code is excluded
283 | from the Corresponding Source as a System Library, need not be
284 | included in conveying the object code work.
285 |
286 | A "User Product" is either (1) a "consumer product", which means any
287 | tangible personal property which is normally used for personal, family,
288 | or household purposes, or (2) anything designed or sold for incorporation
289 | into a dwelling. In determining whether a product is a consumer product,
290 | doubtful cases shall be resolved in favor of coverage. For a particular
291 | product received by a particular user, "normally used" refers to a
292 | typical or common use of that class of product, regardless of the status
293 | of the particular user or of the way in which the particular user
294 | actually uses, or expects or is expected to use, the product. A product
295 | is a consumer product regardless of whether the product has substantial
296 | commercial, industrial or non-consumer uses, unless such uses represent
297 | the only significant mode of use of the product.
298 |
299 | "Installation Information" for a User Product means any methods,
300 | procedures, authorization keys, or other information required to install
301 | and execute modified versions of a covered work in that User Product from
302 | a modified version of its Corresponding Source. The information must
303 | suffice to ensure that the continued functioning of the modified object
304 | code is in no case prevented or interfered with solely because
305 | modification has been made.
306 |
307 | If you convey an object code work under this section in, or with, or
308 | specifically for use in, a User Product, and the conveying occurs as
309 | part of a transaction in which the right of possession and use of the
310 | User Product is transferred to the recipient in perpetuity or for a
311 | fixed term (regardless of how the transaction is characterized), the
312 | Corresponding Source conveyed under this section must be accompanied
313 | by the Installation Information. But this requirement does not apply
314 | if neither you nor any third party retains the ability to install
315 | modified object code on the User Product (for example, the work has
316 | been installed in ROM).
317 |
318 | The requirement to provide Installation Information does not include a
319 | requirement to continue to provide support service, warranty, or updates
320 | for a work that has been modified or installed by the recipient, or for
321 | the User Product in which it has been modified or installed. Access to a
322 | network may be denied when the modification itself materially and
323 | adversely affects the operation of the network or violates the rules and
324 | protocols for communication across the network.
325 |
326 | Corresponding Source conveyed, and Installation Information provided,
327 | in accord with this section must be in a format that is publicly
328 | documented (and with an implementation available to the public in
329 | source code form), and must require no special password or key for
330 | unpacking, reading or copying.
331 |
332 | 7. Additional Terms.
333 |
334 | "Additional permissions" are terms that supplement the terms of this
335 | License by making exceptions from one or more of its conditions.
336 | Additional permissions that are applicable to the entire Program shall
337 | be treated as though they were included in this License, to the extent
338 | that they are valid under applicable law. If additional permissions
339 | apply only to part of the Program, that part may be used separately
340 | under those permissions, but the entire Program remains governed by
341 | this License without regard to the additional permissions.
342 |
343 | When you convey a copy of a covered work, you may at your option
344 | remove any additional permissions from that copy, or from any part of
345 | it. (Additional permissions may be written to require their own
346 | removal in certain cases when you modify the work.) You may place
347 | additional permissions on material, added by you to a covered work,
348 | for which you have or can give appropriate copyright permission.
349 |
350 | Notwithstanding any other provision of this License, for material you
351 | add to a covered work, you may (if authorized by the copyright holders of
352 | that material) supplement the terms of this License with terms:
353 |
354 | a) Disclaiming warranty or limiting liability differently from the
355 | terms of sections 15 and 16 of this License; or
356 |
357 | b) Requiring preservation of specified reasonable legal notices or
358 | author attributions in that material or in the Appropriate Legal
359 | Notices displayed by works containing it; or
360 |
361 | c) Prohibiting misrepresentation of the origin of that material, or
362 | requiring that modified versions of such material be marked in
363 | reasonable ways as different from the original version; or
364 |
365 | d) Limiting the use for publicity purposes of names of licensors or
366 | authors of the material; or
367 |
368 | e) Declining to grant rights under trademark law for use of some
369 | trade names, trademarks, or service marks; or
370 |
371 | f) Requiring indemnification of licensors and authors of that
372 | material by anyone who conveys the material (or modified versions of
373 | it) with contractual assumptions of liability to the recipient, for
374 | any liability that these contractual assumptions directly impose on
375 | those licensors and authors.
376 |
377 | All other non-permissive additional terms are considered "further
378 | restrictions" within the meaning of section 10. If the Program as you
379 | received it, or any part of it, contains a notice stating that it is
380 | governed by this License along with a term that is a further
381 | restriction, you may remove that term. If a license document contains
382 | a further restriction but permits relicensing or conveying under this
383 | License, you may add to a covered work material governed by the terms
384 | of that license document, provided that the further restriction does
385 | not survive such relicensing or conveying.
386 |
387 | If you add terms to a covered work in accord with this section, you
388 | must place, in the relevant source files, a statement of the
389 | additional terms that apply to those files, or a notice indicating
390 | where to find the applicable terms.
391 |
392 | Additional terms, permissive or non-permissive, may be stated in the
393 | form of a separately written license, or stated as exceptions;
394 | the above requirements apply either way.
395 |
396 | 8. Termination.
397 |
398 | You may not propagate or modify a covered work except as expressly
399 | provided under this License. Any attempt otherwise to propagate or
400 | modify it is void, and will automatically terminate your rights under
401 | this License (including any patent licenses granted under the third
402 | paragraph of section 11).
403 |
404 | However, if you cease all violation of this License, then your
405 | license from a particular copyright holder is reinstated (a)
406 | provisionally, unless and until the copyright holder explicitly and
407 | finally terminates your license, and (b) permanently, if the copyright
408 | holder fails to notify you of the violation by some reasonable means
409 | prior to 60 days after the cessation.
410 |
411 | Moreover, your license from a particular copyright holder is
412 | reinstated permanently if the copyright holder notifies you of the
413 | violation by some reasonable means, this is the first time you have
414 | received notice of violation of this License (for any work) from that
415 | copyright holder, and you cure the violation prior to 30 days after
416 | your receipt of the notice.
417 |
418 | Termination of your rights under this section does not terminate the
419 | licenses of parties who have received copies or rights from you under
420 | this License. If your rights have been terminated and not permanently
421 | reinstated, you do not qualify to receive new licenses for the same
422 | material under section 10.
423 |
424 | 9. Acceptance Not Required for Having Copies.
425 |
426 | You are not required to accept this License in order to receive or
427 | run a copy of the Program. Ancillary propagation of a covered work
428 | occurring solely as a consequence of using peer-to-peer transmission
429 | to receive a copy likewise does not require acceptance. However,
430 | nothing other than this License grants you permission to propagate or
431 | modify any covered work. These actions infringe copyright if you do
432 | not accept this License. Therefore, by modifying or propagating a
433 | covered work, you indicate your acceptance of this License to do so.
434 |
435 | 10. Automatic Licensing of Downstream Recipients.
436 |
437 | Each time you convey a covered work, the recipient automatically
438 | receives a license from the original licensors, to run, modify and
439 | propagate that work, subject to this License. You are not responsible
440 | for enforcing compliance by third parties with this License.
441 |
442 | An "entity transaction" is a transaction transferring control of an
443 | organization, or substantially all assets of one, or subdividing an
444 | organization, or merging organizations. If propagation of a covered
445 | work results from an entity transaction, each party to that
446 | transaction who receives a copy of the work also receives whatever
447 | licenses to the work the party's predecessor in interest had or could
448 | give under the previous paragraph, plus a right to possession of the
449 | Corresponding Source of the work from the predecessor in interest, if
450 | the predecessor has it or can get it with reasonable efforts.
451 |
452 | You may not impose any further restrictions on the exercise of the
453 | rights granted or affirmed under this License. For example, you may
454 | not impose a license fee, royalty, or other charge for exercise of
455 | rights granted under this License, and you may not initiate litigation
456 | (including a cross-claim or counterclaim in a lawsuit) alleging that
457 | any patent claim is infringed by making, using, selling, offering for
458 | sale, or importing the Program or any portion of it.
459 |
460 | 11. Patents.
461 |
462 | A "contributor" is a copyright holder who authorizes use under this
463 | License of the Program or a work on which the Program is based. The
464 | work thus licensed is called the contributor's "contributor version".
465 |
466 | A contributor's "essential patent claims" are all patent claims
467 | owned or controlled by the contributor, whether already acquired or
468 | hereafter acquired, that would be infringed by some manner, permitted
469 | by this License, of making, using, or selling its contributor version,
470 | but do not include claims that would be infringed only as a
471 | consequence of further modification of the contributor version. For
472 | purposes of this definition, "control" includes the right to grant
473 | patent sublicenses in a manner consistent with the requirements of
474 | this License.
475 |
476 | Each contributor grants you a non-exclusive, worldwide, royalty-free
477 | patent license under the contributor's essential patent claims, to
478 | make, use, sell, offer for sale, import and otherwise run, modify and
479 | propagate the contents of its contributor version.
480 |
481 | In the following three paragraphs, a "patent license" is any express
482 | agreement or commitment, however denominated, not to enforce a patent
483 | (such as an express permission to practice a patent or covenant not to
484 | sue for patent infringement). To "grant" such a patent license to a
485 | party means to make such an agreement or commitment not to enforce a
486 | patent against the party.
487 |
488 | If you convey a covered work, knowingly relying on a patent license,
489 | and the Corresponding Source of the work is not available for anyone
490 | to copy, free of charge and under the terms of this License, through a
491 | publicly available network server or other readily accessible means,
492 | then you must either (1) cause the Corresponding Source to be so
493 | available, or (2) arrange to deprive yourself of the benefit of the
494 | patent license for this particular work, or (3) arrange, in a manner
495 | consistent with the requirements of this License, to extend the patent
496 | license to downstream recipients. "Knowingly relying" means you have
497 | actual knowledge that, but for the patent license, your conveying the
498 | covered work in a country, or your recipient's use of the covered work
499 | in a country, would infringe one or more identifiable patents in that
500 | country that you have reason to believe are valid.
501 |
502 | If, pursuant to or in connection with a single transaction or
503 | arrangement, you convey, or propagate by procuring conveyance of, a
504 | covered work, and grant a patent license to some of the parties
505 | receiving the covered work authorizing them to use, propagate, modify
506 | or convey a specific copy of the covered work, then the patent license
507 | you grant is automatically extended to all recipients of the covered
508 | work and works based on it.
509 |
510 | A patent license is "discriminatory" if it does not include within
511 | the scope of its coverage, prohibits the exercise of, or is
512 | conditioned on the non-exercise of one or more of the rights that are
513 | specifically granted under this License. You may not convey a covered
514 | work if you are a party to an arrangement with a third party that is
515 | in the business of distributing software, under which you make payment
516 | to the third party based on the extent of your activity of conveying
517 | the work, and under which the third party grants, to any of the
518 | parties who would receive the covered work from you, a discriminatory
519 | patent license (a) in connection with copies of the covered work
520 | conveyed by you (or copies made from those copies), or (b) primarily
521 | for and in connection with specific products or compilations that
522 | contain the covered work, unless you entered into that arrangement,
523 | or that patent license was granted, prior to 28 March 2007.
524 |
525 | Nothing in this License shall be construed as excluding or limiting
526 | any implied license or other defenses to infringement that may
527 | otherwise be available to you under applicable patent law.
528 |
529 | 12. No Surrender of Others' Freedom.
530 |
531 | If conditions are imposed on you (whether by court order, agreement or
532 | otherwise) that contradict the conditions of this License, they do not
533 | excuse you from the conditions of this License. If you cannot convey a
534 | covered work so as to satisfy simultaneously your obligations under this
535 | License and any other pertinent obligations, then as a consequence you may
536 | not convey it at all. For example, if you agree to terms that obligate you
537 | to collect a royalty for further conveying from those to whom you convey
538 | the Program, the only way you could satisfy both those terms and this
539 | License would be to refrain entirely from conveying the Program.
540 |
541 | 13. Remote Network Interaction; Use with the GNU General Public License.
542 |
543 | Notwithstanding any other provision of this License, if you modify the
544 | Program, your modified version must prominently offer all users
545 | interacting with it remotely through a computer network (if your version
546 | supports such interaction) an opportunity to receive the Corresponding
547 | Source of your version by providing access to the Corresponding Source
548 | from a network server at no charge, through some standard or customary
549 | means of facilitating copying of software. This Corresponding Source
550 | shall include the Corresponding Source for any work covered by version 3
551 | of the GNU General Public License that is incorporated pursuant to the
552 | following paragraph.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the work with which it is combined will remain governed by version
560 | 3 of the GNU General Public License.
561 |
562 | 14. Revised Versions of this License.
563 |
564 | The Free Software Foundation may publish revised and/or new versions of
565 | the GNU Affero General Public License from time to time. Such new versions
566 | will be similar in spirit to the present version, but may differ in detail to
567 | address new problems or concerns.
568 |
569 | Each version is given a distinguishing version number. If the
570 | Program specifies that a certain numbered version of the GNU Affero General
571 | Public License "or any later version" applies to it, you have the
572 | option of following the terms and conditions either of that numbered
573 | version or of any later version published by the Free Software
574 | Foundation. If the Program does not specify a version number of the
575 | GNU Affero General Public License, you may choose any version ever published
576 | by the Free Software Foundation.
577 |
578 | If the Program specifies that a proxy can decide which future
579 | versions of the GNU Affero General Public License can be used, that proxy's
580 | public statement of acceptance of a version permanently authorizes you
581 | to choose that version for the Program.
582 |
583 | Later license versions may give you additional or different
584 | permissions. However, no additional obligations are imposed on any
585 | author or copyright holder as a result of your choosing to follow a
586 | later version.
587 |
588 | 15. Disclaimer of Warranty.
589 |
590 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
591 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
592 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
593 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
594 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
595 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
596 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
597 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
598 |
599 | 16. Limitation of Liability.
600 |
601 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
602 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
603 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
604 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
605 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
606 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
607 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
608 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
609 | SUCH DAMAGES.
610 |
611 | 17. Interpretation of Sections 15 and 16.
612 |
613 | If the disclaimer of warranty and limitation of liability provided
614 | above cannot be given local legal effect according to their terms,
615 | reviewing courts shall apply local law that most closely approximates
616 | an absolute waiver of all civil liability in connection with the
617 | Program, unless a warranty or assumption of liability accompanies a
618 | copy of the Program in return for a fee.
619 |
620 | END OF TERMS AND CONDITIONS
621 |
622 | How to Apply These Terms to Your New Programs
623 |
624 | If you develop a new program, and you want it to be of the greatest
625 | possible use to the public, the best way to achieve this is to make it
626 | free software which everyone can redistribute and change under these terms.
627 |
628 | To do so, attach the following notices to the program. It is safest
629 | to attach them to the start of each source file to most effectively
630 | state the exclusion of warranty; and each file should have at least
631 | the "copyright" line and a pointer to where the full notice is found.
632 |
633 |
634 | Copyright (C)
635 |
636 | This program is free software: you can redistribute it and/or modify
637 | it under the terms of the GNU Affero General Public License as published
638 | by the Free Software Foundation, either version 3 of the License, or
639 | (at your option) any later version.
640 |
641 | This program is distributed in the hope that it will be useful,
642 | but WITHOUT ANY WARRANTY; without even the implied warranty of
643 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
644 | GNU Affero General Public License for more details.
645 |
646 | You should have received a copy of the GNU Affero General Public License
647 | along with this program. If not, see .
648 |
649 | Also add information on how to contact you by electronic and paper mail.
650 |
651 | If your software can interact with users remotely through a computer
652 | network, you should also make sure that it provides a way for users to
653 | get its source. For example, if your program is a web application, its
654 | interface could display a "Source" link that leads users to an archive
655 | of the code. There are many ways you could offer source, and different
656 | solutions will be better for different programs; see section 13 for the
657 | specific requirements.
658 |
659 | You should also get your employer (if you work as a programmer) or school,
660 | if any, to sign a "copyright disclaimer" for the program, if necessary.
661 | For more information on this, and how to apply and follow the GNU AGPL, see
662 | .
663 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Git Simple Server — Securely manage your own Git server
2 |
3 | [](https://travis-ci.org/leonklingele/git-simpleserver)
4 |
5 | Git Simple Server (abbreviated "git ss") makes it easy to manage your Git repos on your own server from the command line. It's super lightweight, secure and only requires a shell, `git` and `ssh`.
6 | It has an integrated user management, making it simple to manage read and write permissions on a per-user, per-repo basis.
7 |
8 | 
9 |
10 | ### Create a new repo on your server..
11 |
12 | ```sh
13 | $ git ss repo create server-config-nginx
14 | Repo 'server-config-nginx' was created successfully. Track it as remote 'origin' via:
15 | $ git remote add origin git@leonklingele.de:leon/server-config-nginx
16 | $ git remote set-url origin git@leonklingele.de:leon/server-config-nginx
17 | ```
18 |
19 | ### ..and optionally grant other users access to it
20 |
21 | ```sh
22 | $ git ss repo access server-config-nginx -rw alice
23 | $ git ss repo access server-config-nginx -r bob
24 |
25 | # Oops, "alice" only needs read access, but "bob" should no longer have access at all
26 | $ git ss repo access server-config-nginx -r alice
27 | $ git ss repo access server-config-nginx -rm bob
28 | ```
29 |
30 | ### List repos
31 |
32 | #### List your own repos
33 |
34 | ```sh
35 | $ git ss repo list
36 | server-config-nginx
37 | my-secrets
38 | this-one-awesome-project
39 | ```
40 |
41 | #### List all users who can access a certain repo
42 |
43 | ```sh
44 | $ git ss repo info server-config-nginx
45 | Users with read access:
46 | leon
47 | alice
48 | Users with write access:
49 | leon
50 | ```
51 |
52 | ### Create / modify users (admin only)
53 |
54 | #### List all users (admin only)
55 |
56 | ```sh
57 | $ git ss user list
58 | alice
59 | bob
60 | leon
61 | ```
62 |
63 | #### Create a new user (admin only)
64 |
65 | ```sh
66 | $ git ss user create charlie
67 | Please paste the SSH public key for user 'charlie'. Confirm by pressing the 'Enter' key.
68 | > ssh-rsa ..
69 | User 'charlie' was created successfully
70 | ```
71 |
72 | #### Delete a user (admin only)
73 |
74 | ```sh
75 | $ git ss user delete charlie
76 | Do you really want to delete user 'charlie'? Please answer with YES or NO
77 | > YES
78 | User 'charlie' was deleted successfully
79 | ```
80 |
81 | #### List all repos a user has access to (admin only)
82 |
83 | ```sh
84 | $ git ss user info leon
85 | User 'leon' has read access to:
86 | leon/server-config-nginx
87 | leon/my-secrets
88 | leon/this-one-awesome-project
89 | alice/golang-is-awesome-notes
90 | alice/homework
91 | User 'leon' has write access to:
92 | leon/server-config-nginx
93 | leon/my-secrets
94 | leon/this-one-awesome-project
95 | ```
96 |
97 | # Installation
98 |
99 | First, install the dependencies (most likely you already have them):
100 |
101 | ```sh
102 | apt-get install --no-install-recommends git sudo ssh sed grep make
103 | ```
104 |
105 | This app consists of a server and a client part.
106 | On your server, run:
107 |
108 | ```sh
109 | $ $EDITOR /etc/ssh/sshd_config
110 | # Set `PermitUserEnvironment yes`
111 | # Add these lines to the very end of the file (important):
112 | Match User git
113 | PasswordAuthentication no
114 | PubkeyAuthentication yes
115 | AcceptEnv GIT_SS_REMOTE_VERSION
116 | AllowAgentForwarding no
117 | AllowTcpForwarding no
118 | Banner none
119 | PermitTTY no
120 | X11Forwarding no
121 | # Nothing else should be below the "Match User git" block
122 | $ /etc/init.d/ssh reload
123 | $ cd /usr/local/etc # other users must have read (no write!) access to that folder!
124 | $ git clone https://github.com/leonklingele/git-simpleserver
125 | $ cd git-simpleserver/server
126 | # Choose a username you want to store your repos under, e.g. leon
127 | $ GIT_USER="your-user" make install
128 | # There's one last step:
129 | $ $EDITOR /home/git/.ssh/authorized_keys
130 | # Set "your-ssh-public-key" to your ssh public key, e.g. ssh-rsa AAAAB3N.. you@your-machine
131 | # Full line example: environment="GIT_USER=leon",environment="GIT_ADMIN=true" ssh-rsa AAAAB3N.. you@your-machine
132 | # Save. Enjoy. Now install the client.
133 | ```
134 |
135 | On your client, run:
136 |
137 | ```sh
138 | $ git clone https://github.com/leonklingele/git-simpleserver
139 | $ cd git-simpleserver/client
140 | $ make install
141 | $ $EDITOR $HOME/.git-simpleserver/config.yaml
142 | # Set 'ssh_server' to point to your server
143 | # Don't modify 'ssh_user'
144 | ```
145 |
146 | # Code review: How to manage pull requests
147 |
148 | Looking for a way to manage pull requests for your repositories? git-simpleserver loves [git-appraise](https://github.com/google/git-appraise). It's awesome!
149 |
150 | # How it works
151 |
152 | Normally when logging in into a remote server via `ssh`, you'll get an interactive shell (most likely a `bash`). That's where you type in your fancy commands. Linux lets you define a custom shell to use (see `man chsh`). Instead of `bash`, you can for example define any script (`bash`, `sh`, `python`, ..) as your shell. Upon successful login, this script is executed and can control which commands you are allowed to run and which not.
153 | If `git-simpleserver` is set up on your server and you successfully authenticated as user `git` using your ssh key, a [special shell](./server/shell) is launched. This shell only allows you to run a small number of commands, dedicated to managing your Git repos and Git users.
154 | Now you're logged in as user `git`, but how does `git-simpleserver`'s user management work then? Well, that's another cool feature of OpenSSH: For each public key in `authorized_keys` you can define custom env vars which get set when this public key is used to log in. `git-simpleserver` connects a `GIT_USER` environment variable to each public key. Think of `GIT_USER` as a virtual user name, similar, but still different to the ssh user (`git`). Using `GIT_USER` we know who has logged in and can restrict read and write permissions.
155 | No one can access your repos, unless you explicitly granted permissions to that person via `git ss user add` or the `.ssh/authorized_keys` file.
156 |
157 | # Contact
158 |
159 | Want to share something confidentially? Use my Git email address and this PGP key:
160 | ```pgp
161 | PGP Key ID: 31EEC211 / 0x0C8AF48831EEC211
162 | PGP Key fingerprint: B231 B273 70B7 A050 1CBD 992B 0C8A F488 31EE C211
163 | ```
164 |
--------------------------------------------------------------------------------
/TODO.txt:
--------------------------------------------------------------------------------
1 | TODO:
2 |
3 | For TODOs not listed in here, search for them via:
4 | $ grep -r --exclude-dir=".git" --exclude="TODO.txt" "TODO" .
5 |
6 | - user create --{allow-create-repos,admin}
7 | - Usage: $0
8 | - Debian packaging
9 | - Docker image to quickly set up a self-hosted Git server
10 | - Support multiple profiles (set via config file, e.g. one server for work, one for private stuff)
11 | - Support to rename repos
12 | - Support to enable / disable users
13 | - Check for race conditions / use mutex / file locking
14 | - POSIX compliance
15 | - Repo move command
16 | - Individual error codes, so they can be checked for
17 | - DRY: Don't repeat yourself. Will be hard, we're using plain shell after all, not even bash
18 | - repo --current
19 | - repo create --track
20 | - sshd ChrootDirectory
21 | - Make repos forkable
22 | - Add simple issue tracker (https://github.com/neithernut/git-dit ?)
23 | - Permissions per branch
24 | - Protected branches, so you can't force-push
25 |
--------------------------------------------------------------------------------
/client/Makefile:
--------------------------------------------------------------------------------
1 | GIT_SIMPLESERVER_DIR = $(HOME)/.git-simpleserver
2 | BIN_DIR = /usr/local/bin
3 | INSTALL = install
4 |
5 | install: config
6 | ln -s $(CURDIR)/git-simpleserver $(BIN_DIR)
7 | ln -s $(BIN_DIR)/git-simpleserver $(BIN_DIR)/git-ss
8 |
9 | uninstall:
10 | rm $(BIN_DIR)/git-simpleserver
11 | rm $(BIN_DIR)/git-ss
12 |
13 | config:
14 | @if [ ! -f "$(GIT_SIMPLESERVER_DIR)/config.yaml" ]; then \
15 | OLD_UMASK=$(shell echo `umask`) ; \
16 | umask 077 ; \
17 | mkdir -p $(GIT_SIMPLESERVER_DIR) ; \
18 | $(INSTALL) -c -m 0600 config.yaml.in $(GIT_SIMPLESERVER_DIR)/config.yaml ; \
19 | umask $(OLD_UMASK) > /dev/null ; \
20 | fi
21 |
22 | .PHONY: install config
23 |
--------------------------------------------------------------------------------
/client/config.yaml.in:
--------------------------------------------------------------------------------
1 | default:
2 | ssh_user: git
3 | ssh_server: git.my-server.com
4 | #ssh_port: 22
5 |
--------------------------------------------------------------------------------
/client/git-simpleserver:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | #. "$(git --exec-path)/git-sh-setup"
4 |
5 | set -euf #o pipefail
6 |
7 | export GIT_SS_REMOTE_VERSION="1"
8 |
9 | repo_list() {
10 | local CMD="repo-list"
11 | local OUT
12 | OUT=$(exec_ssh_cmd "$CMD") || (EXIT_CODE=$? ; echo "$OUT" ; exit $EXIT_CODE)
13 | echo "$OUT" | while read -r LINE; do
14 | echo "$LOGIN:$LINE"
15 | done
16 | }
17 | repo_info() {
18 | set +u
19 | if [ "$1" = "--help" ]; then
20 | repo_info_help
21 | exit 0
22 | fi
23 | if [ -z "$*" ]; then
24 | repo_info_help
25 | exit 0
26 | fi
27 | set -u
28 |
29 | local REPO="$*"
30 | local CMD="repo-info '$REPO'"
31 | local OUT
32 | OUT=$(exec_ssh_cmd "$CMD") || (EXIT_CODE=$? ; echo "$OUT" ; exit $EXIT_CODE)
33 |
34 | echo "$OUT"
35 | }
36 | repo_info_help() {
37 | echo "usage: git simpleserver repo info "
38 | }
39 | repo_create() {
40 | local INTERACTIVE_MODE=true
41 | set +u
42 | case "$1" in
43 | "--help")
44 | repo_create_help
45 | exit 0
46 | ;;
47 | "-y")
48 | # Non-interactive mode
49 | INTERACTIVE_MODE=false
50 | shift
51 | ;;
52 | esac
53 | if [ -z "$*" ]; then
54 | repo_create_help
55 | exit 0
56 | fi
57 | set -u
58 |
59 | local NEW_REPO="$*"
60 | if [ "$INTERACTIVE_MODE" = true ]; then
61 | confirm "Do you want to create repo '$NEW_REPO'?"
62 | fi
63 | local CMD="repo-create '$NEW_REPO'"
64 | local OUT
65 | OUT=$(exec_ssh_cmd "$CMD") || (EXIT_CODE=$? ; echo "$OUT" ; exit $EXIT_CODE)
66 |
67 | echo "Repo '$NEW_REPO' was created successfully. Track it as remote 'origin' via:"
68 | echo " $ git remote add origin $LOGIN:$OUT"
69 | echo " $ git remote set-url origin $LOGIN:$OUT"
70 | }
71 | repo_create_help() {
72 | echo "usage: git simpleserver repo create "
73 | }
74 | repo_delete() {
75 | local INTERACTIVE_MODE=true
76 | set +u
77 | case "$1" in
78 | "--help")
79 | repo_delete_help
80 | exit 0
81 | ;;
82 | "-y")
83 | # Non-interactive mode
84 | INTERACTIVE_MODE=false
85 | shift
86 | ;;
87 | esac
88 | if [ -z "$*" ]; then
89 | repo_delete_help
90 | exit 0
91 | fi
92 | set -u
93 |
94 | local REPO_TO_DELETE="$*"
95 | if [ "$INTERACTIVE_MODE" = true ]; then
96 | confirm "Do you really want to delete repo '$REPO_TO_DELETE'?"
97 | fi
98 | local CMD="repo-delete '$REPO_TO_DELETE'"
99 | local OUT
100 | OUT=$(exec_ssh_cmd "$CMD") || (EXIT_CODE=$? ; echo "$OUT" ; exit $EXIT_CODE)
101 |
102 | echo "Repo '$REPO_TO_DELETE' was deleted successfully"
103 | }
104 | repo_delete_help() {
105 | echo "usage: git simpleserver repo delete "
106 | }
107 | repo_access() {
108 | set +u
109 | case "$1" in
110 | "--help")
111 | repo_access_help
112 | exit 0
113 | ;;
114 | esac
115 | if [ $# -ne 3 ]; then
116 | repo_access_help
117 | exit 0
118 | fi
119 | set -u
120 |
121 | local REPO="$1"
122 | local ACCESS_MODE="$2"
123 | local USER="$3"
124 | local CMD="repo-access '$REPO' '$ACCESS_MODE' '$USER'"
125 | local OUT
126 | OUT=$(exec_ssh_cmd "$CMD") || (EXIT_CODE=$? ; echo "$OUT" ; exit $EXIT_CODE)
127 |
128 | echo "$OUT"
129 | }
130 | repo_access_help() {
131 | echo "usage: git simpleserver repo access <-rw | -r | -rm> "
132 | }
133 | repo_help() {
134 | echo "usage: git simpleserver repo "
135 | echo
136 | echo "Available subcommands are:"
137 | echo " list List existing repositories."
138 | echo " info Show info of named repository."
139 | echo " create Create a new named repository."
140 | echo " delete Delete a new named repository."
141 | echo " access Manage access to a named repository."
142 | echo
143 | echo "Try 'git simpleserver repo --help' for details."
144 | }
145 |
146 | user_list() {
147 | set +u
148 | local CMD="user-list '$1'"
149 | set -u
150 |
151 | local OUT
152 | OUT=$(exec_ssh_cmd "$CMD") || (EXIT_CODE=$? ; echo "$OUT" ; exit $EXIT_CODE)
153 |
154 | echo "$OUT"
155 | }
156 | user_info() {
157 | set +u
158 | if [ "$1" = "--help" ]; then
159 | user_info_help
160 | exit 0
161 | fi
162 | if [ -z "$1" ]; then
163 | user_info_help
164 | exit 0
165 | fi
166 | set -u
167 |
168 | local USER="$1"
169 | local CMD="user-info '$USER'"
170 | local OUT
171 | OUT=$(exec_ssh_cmd "$CMD") || (EXIT_CODE=$? ; echo "$OUT" ; exit $EXIT_CODE)
172 |
173 | echo "$OUT"
174 | }
175 | user_info_help() {
176 | echo "usage: git simpleserver user info "
177 | }
178 | user_create() {
179 | local INTERACTIVE_MODE=true
180 | set +u
181 | case "$1" in
182 | "--help")
183 | user_create_help
184 | exit 0
185 | ;;
186 | "-y")
187 | # Non-interactive mode
188 | INTERACTIVE_MODE=false
189 | shift
190 | ;;
191 | esac
192 | if [ -z "$1" ]; then
193 | user_create_help
194 | exit 0
195 | fi
196 | set -u
197 |
198 | local NEW_USER="$1"
199 | set +u
200 | local PUBLIC_KEY="$2"
201 | set -u
202 | if [ "$INTERACTIVE_MODE" = true ] || [ ! -n "$PUBLIC_KEY" ]; then
203 | echo "Please paste the SSH public key for user '$NEW_USER'. Confirm by pressing the 'Enter' key."
204 | PUBLIC_KEY=$(do_read)
205 | fi
206 | local CMD="user-create '$NEW_USER' '$PUBLIC_KEY'"
207 | local OUT
208 | OUT=$(exec_ssh_cmd "$CMD") || (EXIT_CODE=$? ; echo "$OUT" ; exit $EXIT_CODE)
209 |
210 | echo "User '$NEW_USER' was created successfully"
211 | }
212 | user_create_help() {
213 | echo "usage: git simpleserver user create "
214 | }
215 | user_delete() {
216 | local INTERACTIVE_MODE=true
217 | set +u
218 | case "$1" in
219 | "--help")
220 | user_delete_help
221 | exit 0
222 | ;;
223 | "-y")
224 | # Non-interactive mode
225 | INTERACTIVE_MODE=false
226 | shift
227 | ;;
228 | esac
229 | if [ -z "$1" ]; then
230 | user_delete_help
231 | exit 0
232 | fi
233 | set -u
234 |
235 | local USER_TO_DELETE="$1"
236 | if [ "$INTERACTIVE_MODE" = true ]; then
237 | confirm "Do you really want to delete user '$USER_TO_DELETE'?"
238 | fi
239 | local CMD="user-delete '$USER_TO_DELETE'"
240 | local OUT
241 | OUT=$(exec_ssh_cmd "$CMD") || (EXIT_CODE=$? ; echo "$OUT" ; exit $EXIT_CODE)
242 |
243 | echo "User '$USER_TO_DELETE' was deleted successfully"
244 | }
245 | user_delete_help() {
246 | echo "usage: git simpleserver user delete "
247 | }
248 | user_help() {
249 | echo "usage: git simpleserver user "
250 | echo
251 | echo "Available subcommands are:"
252 | echo " list [-v] List existing users."
253 | echo " info Show info of named user."
254 | echo " create Create a new named user."
255 | echo " delete Delete a new named user."
256 | echo
257 | echo "Try 'git simpleserver user --help' for details."
258 | }
259 |
260 | do_read() {
261 | # TODO(leon): Hack to print and return something
262 | printf "%s " ">" > /dev/null >&2
263 | read -r ANSWER
264 | echo "$ANSWER"
265 | }
266 |
267 | confirm() {
268 | MSG="$1"
269 | PROMPT="Please answer with YES or NO"
270 | # POSIX shell's `echo` has no support for flags
271 | echo "$MSG $PROMPT"
272 | local ANSWER=$(do_read)
273 | case "$ANSWER" in
274 | "YES")
275 | return 0
276 | ;;
277 | "NO")
278 | exit 1
279 | ;;
280 | *)
281 | echo "$PROMPT, you typed: $ANSWER"
282 | exit 1
283 | ;;
284 | esac
285 | }
286 |
287 | exec_ssh_cmd() {
288 | local CMD="$1"
289 | local OUT
290 | local EXIT_CODE
291 | set +e
292 | OUT=$(ssh -o SendEnv=GIT_SS_REMOTE_VERSION -p "$PORT" "$LOGIN" -- "$CMD" 2>&1)
293 | EXIT_CODE=$?
294 | set -e
295 | if [ $EXIT_CODE -ne 0 ]; then
296 | echo "Error! $OUT"
297 | exit $EXIT_CODE
298 | fi
299 | echo "$OUT"
300 | }
301 |
302 | main() {
303 | CMD="usage"
304 |
305 | local PARAM1
306 | local PARAM2
307 | if [ $# -gt 0 ]; then
308 | PARAM1="$1"
309 | shift
310 | fi
311 | if [ $# -gt 0 ]; then
312 | PARAM2="$1"
313 | shift
314 | fi
315 |
316 | case "$PARAM1" in
317 | "repo" | "repos")
318 | case "$PARAM2" in
319 | "list" | "ls")
320 | CMD="repo_list"
321 | ;;
322 | "info")
323 | CMD="repo_info"
324 | ;;
325 | "create" | "add" | "new")
326 | CMD="repo_create"
327 | ;;
328 | "delete" | "remove" | "rm")
329 | CMD="repo_delete"
330 | ;;
331 | "access")
332 | CMD="repo_access"
333 | ;;
334 | *)
335 | CMD="repo_help"
336 | ;;
337 | esac
338 | ;;
339 | "user" | "users")
340 | case "$PARAM2" in
341 | "list" | "ls")
342 | CMD="user_list"
343 | ;;
344 | "info")
345 | CMD="user_info"
346 | ;;
347 | "create" | "add" | "new")
348 | CMD="user_create"
349 | ;;
350 | "delete" | "remove" | "rm")
351 | CMD="user_delete"
352 | ;;
353 | *)
354 | CMD="user_help"
355 | ;;
356 | esac
357 | ;;
358 | esac
359 |
360 | eval "$CMD" "$@"
361 | }
362 |
363 | usage() {
364 | echo "usage: git simpleserver [options] "
365 | echo
366 | echo "Available options are:"
367 | echo " --config Specify path to config file to use."
368 | echo
369 | echo "Available subcommands are:"
370 | echo " repo Create, list and modify repositories."
371 | echo " user Create, list and modify users (admin only)."
372 | echo
373 | echo "Try 'git simpleserver --help' for details."
374 | exit 1
375 | }
376 |
377 | # Stolen from https://gist.github.com/pkuczynski/8665367
378 | parse_yaml() {
379 | local prefix="$2"
380 | local s
381 | local w
382 | local fs
383 | s='[[:space:]]*'
384 | w='[a-zA-Z0-9_]*'
385 | fs="$(echo @|tr @ '\034')"
386 | sed -ne "s|^\($s\)\($w\)$s:$s\"\(.*\)\"$s\$|\1$fs\2$fs\3|p" \
387 | -e "s|^\($s\)\($w\)$s:$s\(.*\)$s\$|\1$fs\2$fs\3|p" "$1" |
388 | awk -F"$fs" '{
389 | indent = length($1)/2;
390 | vname[indent] = $2;
391 | for (i in vname) {if (i > indent) {delete vname[i]}}
392 | if (length($3) > 0) {
393 | vn=""; for (i=0; i> "$FILE_NAME"
89 | echo "User '$USER' now has $NAMED_ACCESS_MODE access"
90 | fi
91 | else
92 | # Remove access
93 | sed -i "/$MATCH/d" "$FILE_NAME"
94 | echo "User '$USER' no longer has $NAMED_ACCESS_MODE access"
95 | fi
96 | }
97 |
98 | _modify_access "read"
99 | _modify_access "write"
100 |
--------------------------------------------------------------------------------
/server/git-shell-commands/repo-create:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | NEW_REPO="$*"
4 |
5 | set -euf #o pipefail
6 | cd "$REPO_USER_PATH"
7 |
8 | # TODO(leon): DRY
9 | if ! (echo "$NEW_REPO" | grep -xq '^[a-zA-Z0-9_-]*$'); then
10 | echo "Disallowed characters in repo name. Allowed: a-z, A-Z, 0-9, _, -"
11 | exit 1
12 | fi
13 |
14 | if [ -z "$NEW_REPO" ]; then
15 | echo "No repo name specified"
16 | exit 1
17 | fi
18 |
19 | if [ -e "$NEW_REPO/$FILE_NAME_MARKER" ]; then
20 | echo "Repo '$NEW_REPO' already exists"
21 | exit 1
22 | fi
23 |
24 | mkdir -- "$NEW_REPO"
25 | cd -- "$NEW_REPO"
26 |
27 | git init --bare > /dev/null
28 |
29 | echo "$GIT_USER" > "$FILE_NAME_ACCESS_READ"
30 | echo "$GIT_USER" > "$FILE_NAME_ACCESS_WRITE"
31 | touch "$FILE_NAME_MARKER"
32 |
33 | echo "$GIT_USER/$NEW_REPO"
34 |
--------------------------------------------------------------------------------
/server/git-shell-commands/repo-delete:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | REPO_TO_DELETE="$*"
4 |
5 | set -euf #o pipefail
6 | cd "$REPO_USER_PATH"
7 |
8 | # TODO(leon): DRY
9 | if ! (echo "$REPO_TO_DELETE" | grep -xq '^[a-zA-Z0-9_-]*$'); then
10 | echo "Disallowed characters in repo name. Allowed: a-z, A-Z, 0-9, _, -"
11 | exit 1
12 | fi
13 |
14 | if [ -z "$REPO_TO_DELETE" ]; then
15 | echo "No repo name specified"
16 | exit 1
17 | fi
18 |
19 | if [ ! -e "$REPO_TO_DELETE/$FILE_NAME_MARKER" ]; then
20 | echo "Repo '$REPO_TO_DELETE' does not exist"
21 | exit 1
22 | fi
23 |
24 | rm -rf -- "$REPO_TO_DELETE"
25 |
--------------------------------------------------------------------------------
/server/git-shell-commands/repo-info:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | REPO="$*"
4 |
5 | set -euf #o pipefail
6 | cd "$REPO_USER_PATH"
7 |
8 | # TODO(leon): DRY
9 | if ! (echo "$REPO" | grep -xq '^[a-zA-Z0-9_-]*$'); then
10 | echo "Disallowed characters in repo name. Allowed: a-z, A-Z, 0-9, _, -"
11 | exit 1
12 | fi
13 |
14 | if [ -z "$REPO" ]; then
15 | echo "No repo name specified"
16 | exit 1
17 | fi
18 |
19 | if [ ! -e "$REPO/$FILE_NAME_MARKER" ]; then
20 | echo "Repo '$REPO' does not exist"
21 | exit 1
22 | fi
23 |
24 | cd -- "$REPO"
25 |
26 | echo "Users with read access:"
27 | while read -r LINE; do
28 | echo " $LINE"
29 | done < "$FILE_NAME_ACCESS_READ"
30 |
31 | echo "Users with write access:"
32 | while read -r LINE; do
33 | echo " $LINE"
34 | done < "$FILE_NAME_ACCESS_WRITE"
35 |
--------------------------------------------------------------------------------
/server/git-shell-commands/repo-list:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | set -euf #o pipefail
4 | cd "$REPO_USER_PATH"
5 |
6 | OUT=$(find . -type f -name "$FILE_NAME_MARKER" -exec printf "$GIT_USER/" \; -exec /bin/sh -c "dirname -- '{}' | cut -c 3-" \;)
7 | if [ -z "$OUT" ]; then
8 | echo "No repos found!"
9 | exit 1
10 | fi
11 | echo "$OUT"
12 |
--------------------------------------------------------------------------------
/server/git-shell-commands/user-create:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | NEW_USER="$1"
4 | PUBLIC_KEY="$2"
5 |
6 | set -euf #o pipefail
7 |
8 | if [ ! -f "$FILE_PATH_AUTHORIZED_KEYS" ]; then
9 | echo "File '$FILE_PATH_AUTHORIZED_KEYS' does not exist"
10 | exit 1
11 | fi
12 |
13 | # TODO(leon): DRY
14 | if ! (echo "$NEW_USER" | grep -xq '^[a-zA-Z0-9_-]*$'); then
15 | echo "Disallowed characters in user name. Allowed: a-z, A-Z, 0-9, _, -"
16 | exit 1
17 | fi
18 |
19 | if [ -z "$NEW_USER" ]; then
20 | echo "No user name specified"
21 | exit 1
22 | fi
23 |
24 | # TODO(leon): DRY
25 | # Regex is not an issue here, .* is not allowed in user names :)
26 | MATCH="^environment=\"GIT_USER=$NEW_USER\".*$"
27 | if grep -xq "$MATCH" "$FILE_PATH_AUTHORIZED_KEYS"; then
28 | echo "User '$NEW_USER' already exists"
29 | exit 1
30 | fi
31 |
32 | if [ -z "$PUBLIC_KEY" ]; then
33 | echo "No public key specified"
34 | exit 1
35 | fi
36 |
37 | if (echo "$PUBLIC_KEY" | grep -xPq '^.*(\047|\042).*$'); then
38 | echo 'Disallowed characters in public key. Disallowed: '"'"', "'
39 | exit 1
40 | fi
41 |
42 | # TODO(leon): Do we want to validate ssh-key type (e.g. rsa / ed25519 / ..)?
43 | case "$PUBLIC_KEY" in
44 | 'ssh-'*)
45 | ;;
46 | *)
47 | echo "Not a valid public key! SSH public keys must start with 'ssh-'"
48 | exit 1
49 | ;;
50 | esac
51 |
52 | printf 'environment="GIT_USER=%s" %s\n' "$NEW_USER" "$PUBLIC_KEY" >> "$FILE_PATH_AUTHORIZED_KEYS"
53 |
--------------------------------------------------------------------------------
/server/git-shell-commands/user-delete:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | USER_TO_DELETE="$1"
4 |
5 | set -euf #o pipefail
6 |
7 | if [ ! -f "$FILE_PATH_AUTHORIZED_KEYS" ]; then
8 | echo "File '$FILE_PATH_AUTHORIZED_KEYS' does not exist"
9 | exit 1
10 | fi
11 |
12 | if [ -z "$USER_TO_DELETE" ]; then
13 | echo "No user name specified"
14 | exit 1
15 | fi
16 |
17 | # TODO(leon): DRY
18 | if ! (echo "$USER_TO_DELETE" | grep -xq '^[a-zA-Z0-9_-]*$'); then
19 | echo "Disallowed characters in user name. Allowed: a-z, A-Z, 0-9, _, -"
20 | exit 1
21 | fi
22 |
23 | if [ "$GIT_USER" = "$USER_TO_DELETE" ]; then
24 | echo "You can't delete yourself :) Sometimes I hate myself as well, but what you're trying to do is just too rude."
25 | exit 1
26 | fi
27 |
28 | # Regex is not an issue here, .* is not allowed in user names :)
29 | MATCH="^environment=\"GIT_USER=$USER_TO_DELETE\".*$"
30 | if ! grep -xq "$MATCH" "$FILE_PATH_AUTHORIZED_KEYS"; then
31 | echo "User '$USER_TO_DELETE' does not exist"
32 | exit 1
33 | fi
34 |
35 | sed -i "/$MATCH/d" "$FILE_PATH_AUTHORIZED_KEYS"
36 |
--------------------------------------------------------------------------------
/server/git-shell-commands/user-info:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | USER="$*"
4 |
5 | set -euf #o pipefail
6 | cd "$REPOS_PATH"
7 |
8 | # TODO(leon): DRY
9 | if [ ! -f "$FILE_PATH_AUTHORIZED_KEYS" ]; then
10 | echo "File '$FILE_PATH_AUTHORIZED_KEYS' does not exist"
11 | exit 1
12 | fi
13 |
14 | # TODO(leon): DRY
15 | # Regex is not an issue here, .* is not allowed in user names :)
16 | MATCH="^environment=\"GIT_USER=$USER\".*$"
17 | if ! grep -xq "$MATCH" "$FILE_PATH_AUTHORIZED_KEYS"; then
18 | echo "User '$USER' does not exist"
19 | exit 1
20 | fi
21 |
22 | _list_access() {
23 | local NAMED_ACCESS_MODE="$1"
24 | local FILE_NAME
25 | case "$NAMED_ACCESS_MODE" in
26 | "read")
27 | FILE_NAME="$FILE_NAME_ACCESS_READ"
28 | ;;
29 | "write")
30 | FILE_NAME="$FILE_NAME_ACCESS_WRITE"
31 | ;;
32 | *)
33 | # This should never happen, but why not.
34 | echo "Unknown named access mode: '$NAMED_ACCESS_MODE'"
35 | exit 1
36 | ;;
37 | esac
38 |
39 | echo "User '$USER' has $NAMED_ACCESS_MODE access to:"
40 | find . -type f -name "$FILE_NAME" -exec \
41 | grep -xq "^$USER$" '{}' \; -exec \
42 | dirname -- '{}' \; | \
43 | LC_ALL=C sort | \
44 | while read -r LINE; do
45 | REPO=$(echo "$LINE" | cut -c 3-)
46 | echo " $REPO"
47 | done
48 | }
49 |
50 | _list_access "read"
51 | _list_access "write"
52 |
--------------------------------------------------------------------------------
/server/git-shell-commands/user-list:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | ARG1="$1"
4 |
5 | set -euf #o pipefail
6 |
7 | if [ ! -f "$FILE_PATH_AUTHORIZED_KEYS" ]; then
8 | echo "File '$FILE_PATH_AUTHORIZED_KEYS' does not exist"
9 | exit 1
10 | fi
11 |
12 | while read -r LINE; do
13 | FIRST_LETTER=$(echo "$LINE" | head -c 1)
14 | # TODO(leon): We might want to grep as well, so comment-lines can even start with a space
15 | if [ "$FIRST_LETTER" = "#" ]; then
16 | # It's a comment, ignore this line
17 | continue
18 | fi
19 |
20 | # TODO(leon): Wow, this is such a hack! :o Switch to bash? Now?
21 | USER=${LINE#'environment="GIT_USER='} # Everything after 'env..GIT_USER=', i.e. username followed by everything else
22 | USER=$(echo "$USER" | cut -d '"' -f1) # split by '"' and use first result, i.e. username
23 | TO_REMOVE=$(echo "$LINE" | cut -d ' ' -f1) # split line by ' ', use 3rd result, i.e. everything in front of the SSH public key
24 | PUBLIC_KEY=${LINE#$TO_REMOVE} # remove 'TO_REMOVE' from line to get public key
25 | PUBLIC_KEY=${PUBLIC_KEY#?} # remove leading space from public key
26 |
27 | if [ "$ARG1" = "-v" ]; then
28 | echo "$USER :: $PUBLIC_KEY"
29 | else
30 | echo "$USER"
31 | fi
32 | done < "$FILE_PATH_AUTHORIZED_KEYS"
33 |
--------------------------------------------------------------------------------
/server/shell:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | if [ -z "$GIT_USER" ]; then
4 | echo "Need to have a GIT_USER name"
5 | exit 1
6 | fi
7 |
8 | export GIT_SS_LOCAL_VERSION="1"
9 | export FILE_PATH_LOG="$HOME/log.txt"
10 |
11 | export FILE_NAME_MARKER=".ss-marker"
12 | export FILE_NAME_ACCESS_READ=".ss-access_read"
13 | export FILE_NAME_ACCESS_WRITE=".ss-access_write"
14 | export FILE_PATH_AUTHORIZED_KEYS="$HOME/.ssh/authorized_keys"
15 | export REPOS_PATH="$HOME/repos"
16 | export REPO_USER_PATH="$REPOS_PATH/$GIT_USER"
17 |
18 | CMD="$2"
19 | _ACCESSED_REPO_NAME=${CMD#* } # remove first parameter
20 | _ACCESSED_REPO_NAME=${_ACCESSED_REPO_NAME#"'"} # replace leading '
21 | _ACCESSED_REPO_NAME=${_ACCESSED_REPO_NAME%"'"} # replace trailing '
22 | export ACCESSED_REPO_PATH="$REPOS_PATH/$_ACCESSED_REPO_NAME"
23 |
24 | set -euf #o pipefail
25 |
26 | log() {
27 | echo "$@" >> "$FILE_PATH_LOG"
28 | }
29 |
30 | if [ ! -d "$REPO_USER_PATH" ]; then
31 | log "You don't have an users folder yet, $GIT_USER"
32 | exit 1
33 | fi
34 |
35 | if [ $# -ne 2 ] || [ "$1" != "-c" ]; then
36 | log "Interactive login not permitted"
37 | echo "Interactive login not permitted"
38 | exit 1
39 | fi
40 |
41 | require_admin_access() {
42 | set +u
43 | if [ "$GIT_ADMIN" != "true" ]; then
44 | echo "You are not allowed to do that"
45 | exit 1
46 | fi
47 | set -u
48 | }
49 |
50 | _require_access_mode() {
51 | if [ ! -d "$ACCESSED_REPO_PATH" ]; then
52 | log "Accessed repo does not exist: $ACCESSED_REPO_PATH"
53 | exit 1
54 | fi
55 |
56 | local MODE="$1"
57 | local ACCESS_FILE
58 | case "$MODE" in
59 | "read")
60 | ACCESS_FILE="$FILE_NAME_ACCESS_READ"
61 | ;;
62 | "write")
63 | ACCESS_FILE="$FILE_NAME_ACCESS_WRITE"
64 | ;;
65 | *)
66 | echo "No such mode: '$MODE'"
67 | exit 1
68 | ;;
69 | esac
70 |
71 | if [ ! -f "$ACCESSED_REPO_PATH/$ACCESS_FILE" ]; then
72 | log "File '$ACCESSED_REPO_PATH/$ACCESS_FILE' does not exist"
73 | exit 1
74 | fi
75 | if ! grep -xq "^$GIT_USER$" "$ACCESSED_REPO_PATH/$ACCESS_FILE"; then
76 | log "User '$GIT_USER' has no $MODE access to '$ACCESSED_REPO_PATH'"
77 | exit 1
78 | fi
79 | log "User '$GIT_USER' has $MODE access to '$ACCESSED_REPO_PATH'"
80 | }
81 |
82 | require_read_access() {
83 | _require_access_mode "read"
84 | }
85 |
86 | require_write_access() {
87 | _require_access_mode "write"
88 | }
89 |
90 | # Even if this might look vulnerable to a prefix / suffix attack to pass authentication
91 | # (e.g. " git-receive-pack" or "user ; some-other-command"), it is safe :)
92 | DO_REQUIRE_ADMIN=true
93 | DO_REQUIRE_READ_ACCESS=true
94 | DO_REQUIRE_WRITE_ACCESS=true
95 | DO_REQUIRE_VERSION=true
96 | case "$CMD" in
97 | "git-receive-pack"*)
98 | DO_REQUIRE_ADMIN=false
99 | DO_REQUIRE_READ_ACCESS=false
100 | DO_REQUIRE_VERSION=false
101 | CMD="git-receive-pack '$ACCESSED_REPO_PATH'"
102 | ;;
103 | "git-upload-pack"*)
104 | DO_REQUIRE_ADMIN=false
105 | DO_REQUIRE_WRITE_ACCESS=false
106 | DO_REQUIRE_VERSION=false
107 | CMD="git-upload-pack '$ACCESSED_REPO_PATH'"
108 | ;;
109 | "git-upload-archive"*)
110 | DO_REQUIRE_ADMIN=false
111 | DO_REQUIRE_WRITE_ACCESS=false
112 | DO_REQUIRE_VERSION=false
113 | CMD="git-upload-archive '$ACCESSED_REPO_PATH'"
114 | ;;
115 | "user"*)
116 | DO_REQUIRE_READ_ACCESS=false
117 | DO_REQUIRE_WRITE_ACCESS=false
118 | ;;
119 | "repo"*)
120 | DO_REQUIRE_ADMIN=false
121 | DO_REQUIRE_READ_ACCESS=false
122 | DO_REQUIRE_WRITE_ACCESS=false
123 | ;;
124 | esac
125 |
126 | if [ "$DO_REQUIRE_ADMIN" = true ]; then
127 | require_admin_access
128 | fi
129 |
130 | if [ "$DO_REQUIRE_READ_ACCESS" = true ]; then
131 | require_read_access
132 | fi
133 |
134 | if [ "$DO_REQUIRE_WRITE_ACCESS" = true ]; then
135 | require_write_access
136 | fi
137 |
138 | if [ "$DO_REQUIRE_VERSION" = true ]; then
139 | set +u
140 | if [ -z "$GIT_SS_REMOTE_VERSION" ]; then
141 | echo "Need to have a GIT_SS_REMOTE_VERSION env var"
142 | exit 1
143 | fi
144 | set -u
145 | if [ "$GIT_SS_REMOTE_VERSION" != "$GIT_SS_LOCAL_VERSION" ]; then
146 | MSG="Your git-simpleserver client is outdated. Please update."
147 | if [ "$GIT_SS_REMOTE_VERSION" -gt "$GIT_SS_LOCAL_VERSION" ]; then
148 | MSG="The git-simpleserver server is outdated. Please update."
149 | fi
150 | echo "$MSG You: v$GIT_SS_REMOTE_VERSION, server: v$GIT_SS_LOCAL_VERSION"
151 | exit 1
152 | fi
153 | fi
154 |
155 | log "Executing '$CMD'"
156 | git-shell -c "$CMD"
157 |
--------------------------------------------------------------------------------
/tests/01-repo.test:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | . "$TESTSDIR/common-repo.sh"
4 |
5 | INVALID_REPO_NAME_ERROR_MSG="Error! Disallowed characters in repo name. Allowed: a-z, A-Z, 0-9, _, -"
6 |
7 | # Test repo listing & creation
8 | repos_list_count_must_equal "0"
9 | repo_create "test" # should not fail
10 | repos_list_count_must_equal "1"
11 | repo_create "test2" # should not fail
12 | repos_list_count_must_equal "2"
13 | repo_create "test3" # should not fail
14 | repos_list_count_must_equal "3"
15 | repo_create "test2" "Error! Repo 'test2' already exists" # create test2 a second time, should fail
16 | repos_list_count_must_equal "3"
17 | repo_create "my test" "$INVALID_REPO_NAME_ERROR_MSG"
18 | repo_create "my.test" "$INVALID_REPO_NAME_ERROR_MSG"
19 | repo_create "my–test" "$INVALID_REPO_NAME_ERROR_MSG" # endash
20 | repo_create 'my\\test' "$INVALID_REPO_NAME_ERROR_MSG"
21 | repo_create 'lal\\\\a' "$INVALID_REPO_NAME_ERROR_MSG"
22 | repo_create "my+test" "$INVALID_REPO_NAME_ERROR_MSG"
23 | repo_create "my/test" "$INVALID_REPO_NAME_ERROR_MSG"
24 | repos_list_count_must_equal "3"
25 |
26 | # Test repo deletion
27 | repo_delete "test"
28 | repos_list_count_must_equal "2"
29 | repo_delete "test" "Error! Repo 'test' does not exist"
30 | repos_list_count_must_equal "2"
31 | repo_delete "my/test" "$INVALID_REPO_NAME_ERROR_MSG" # just to make sure slash never works
32 | repos_list_count_must_equal "2"
33 |
34 | # Test repo info of non-existing repo
35 | repo_info "test-non-existing" "Error! Repo 'test-non-existing' does not exist"
36 |
37 | # Test repo info of existing repo
38 | repo_info "test2" "Users with read access:
39 | $USER_NAME
40 | Users with write access:
41 | $USER_NAME"
42 | repo_access "test2" "-rw" "blubb" "User 'blubb' now has read access
43 | User 'blubb' now has write access"
44 | repo_info "test2" "Users with read access:
45 | $USER_NAME
46 | blubb
47 | Users with write access:
48 | $USER_NAME
49 | blubb"
50 | repo_access "test2" "-r" "blubb" "User 'blubb' already has read access
51 | User 'blubb' no longer has write access"
52 | repo_info "test2" "Users with read access:
53 | $USER_NAME
54 | blubb
55 | Users with write access:
56 | $USER_NAME"
57 | repo_access "test2" "-rm" "blubb" "User 'blubb' no longer has read access
58 | User 'blubb' no longer has write access"
59 | repo_info "test2" "Users with read access:
60 | $USER_NAME
61 | Users with write access:
62 | $USER_NAME"
63 |
--------------------------------------------------------------------------------
/tests/02-user.test:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | . "$TESTSDIR/common-user.sh"
4 |
5 | INVALID_SSH_KEY_ERROR_MSG="Error! Not a valid public key! SSH public keys must start with 'ssh-'"
6 | INVALID_USER_NAME_ERROR_MSG="Error! Disallowed characters in user name. Allowed: a-z, A-Z, 0-9, _, -"
7 |
8 | # Test user listing & creation
9 | users_list_count_must_equal "1"
10 | user_create "test" "ssh-rsa"
11 | users_list_count_must_equal "2"
12 | user_create "test2" "ssh-ed25519"
13 | users_list_count_must_equal "3"
14 | user_create "invalid-ssh" "invalid-ssh" "$INVALID_SSH_KEY_ERROR_MSG"
15 | user_create "invalid-ssh" "ssh" "$INVALID_SSH_KEY_ERROR_MSG"
16 | user_create "invalid/user" "ssh-rsa" "$INVALID_USER_NAME_ERROR_MSG"
17 | user_create "invalid=user" "ssh-rsa" "$INVALID_USER_NAME_ERROR_MSG"
18 | users_list_count_must_equal "3"
19 | user_create "test" "ssh-rsa" "Error! User 'test' already exists"
20 | users_list_count_must_equal "3"
21 |
22 | # Test user deletion
23 | user_delete "test2"
24 | users_list_count_must_equal "2"
25 | user_delete "test2" "Error! User 'test2' does not exist"
26 | users_list_count_must_equal "2"
27 | user_delete "/" "$INVALID_USER_NAME_ERROR_MSG"
28 | user_delete "=" "$INVALID_USER_NAME_ERROR_MSG"
29 | users_list_count_must_equal "2"
30 |
31 | # Test user info of non-existing repo
32 | user_info "test4" "Error! User 'test4' does not exist"
33 |
34 | # Test repo info of existing repo
35 | user_info "$USER_NAME" "User '$USER_NAME' has read access to:
36 | $USER_NAME/test2
37 | $USER_NAME/test3
38 | User '$USER_NAME' has write access to:
39 | $USER_NAME/test2
40 | $USER_NAME/test3"
41 |
--------------------------------------------------------------------------------
/tests/03-cleanup.test:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | . "$TESTSDIR/common-repo.sh"
4 | . "$TESTSDIR/common-user.sh"
5 |
6 | # Clean up repos
7 | repo_delete "test2"
8 | repo_delete "test3"
9 |
10 | # Clean up users
11 | user_delete "test"
12 |
--------------------------------------------------------------------------------
/tests/common-repo.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | . "$TESTSDIR/common.sh"
4 |
5 | repos_list_count_must_equal() {
6 | local EXPECTED_COUNT="$1"
7 | local REPO_LIST
8 | local EXIT_CODE
9 |
10 | set +e
11 | REPO_LIST=$(git ss repo list)
12 | EXIT_CODE=$?
13 | set -e
14 |
15 | if [ $EXIT_CODE -ne 0 ]; then
16 | if [ "$EXPECTED_COUNT" = "0" ]; then
17 | # Everything is fine
18 | return 0
19 | fi
20 | echo "Error code $EXIT_CODE :: $REPO_LIST"
21 | exit 1
22 | fi
23 | local REPO_LIST_COUNT=$(echo "$REPO_LIST" | wc -l)
24 | if [ "$REPO_LIST_COUNT" != "$EXPECTED_COUNT" ]; then
25 | echo "Error! Too many repos available: $REPO_LIST_COUNT, expected $EXPECTED_COUNT. Found repos:\n$REPO_LIST"
26 | exit 1
27 | fi
28 | }
29 |
30 | repo_create() {
31 | local NAME="$1"
32 | set +u
33 | local EXPECTED_ERROR_STRING="$2"
34 | set -u
35 | local OUT
36 | local EXIT_CODE
37 |
38 | set +e
39 | OUT=$(git ss repo create -y "$NAME")
40 | EXIT_CODE=$?
41 | set -e
42 |
43 | if [ $EXIT_CODE -ne 0 ]; then
44 | if [ -n "$EXPECTED_ERROR_STRING" ] && [ "$EXPECTED_ERROR_STRING" = "$OUT" ]; then
45 | # Everything is fine
46 | return 0
47 | fi
48 | echo "Error code $EXIT_CODE :: $OUT, name: '$NAME'"
49 | exit 1
50 | fi
51 | }
52 |
53 | repo_delete() {
54 | local NAME="$1"
55 | set +u
56 | local EXPECTED_ERROR_STRING="$2"
57 | set -u
58 | local OUT
59 | local EXIT_CODE
60 |
61 | set +e
62 | OUT=$(git ss repo delete -y "$NAME")
63 | EXIT_CODE=$?
64 | set -e
65 |
66 | if [ $EXIT_CODE -ne 0 ]; then
67 | if [ -n "$EXPECTED_ERROR_STRING" ] && [ "$EXPECTED_ERROR_STRING" = "$OUT" ]; then
68 | # Everything is fine
69 | return 0
70 | fi
71 | echo "Error code $EXIT_CODE :: $OUT, name: '$NAME'"
72 | exit 1
73 | fi
74 | }
75 |
76 | repo_access() {
77 | local REPO_NAME="$1"
78 | local ACCESS_MODE="$2"
79 | local USER_NAME="$3"
80 | local EXPECTED_STRING="$4"
81 | local OUT
82 | local EXIT_CODE
83 |
84 | set +e
85 | OUT=$(git ss repo access "$REPO_NAME" "$ACCESS_MODE" "$USER_NAME")
86 | EXIT_CODE=$?
87 | set -e
88 |
89 | if [ $EXIT_CODE -ne 0 ]; then
90 | if [ -n "$EXPECTED_STRING" ] && [ "$EXPECTED_STRING" = "$OUT" ]; then
91 | # Everything is fine
92 | return 0
93 | fi
94 | echo "Error code $EXIT_CODE :: $OUT, name: '$REPO_NAME', access mode: '$ACCESS_MODE', user name: '$USER_NAME'"
95 | exit 1
96 | else
97 | if [ -n "$EXPECTED_STRING" ] && [ "$EXPECTED_STRING" = "$OUT" ]; then
98 | # Everything is fine
99 | return 0
100 | fi
101 | echo "Error, didn't get expected result for repo '$REPO_NAME', access mode '$ACCESS_MODE', user '$USER_NAME': '$OUT'"
102 | exit 1
103 | fi
104 | }
105 |
106 | repo_info() {
107 | local NAME="$1"
108 | local EXPECTED_STRING="$2"
109 | local OUT
110 | local EXIT_CODE
111 |
112 | set +e
113 | OUT=$(git ss repo info "$NAME")
114 | EXIT_CODE=$?
115 | set -e
116 |
117 | if [ $EXIT_CODE -ne 0 ]; then
118 | if [ -n "$EXPECTED_STRING" ] && [ "$EXPECTED_STRING" = "$OUT" ]; then
119 | # Everything is fine
120 | return 0
121 | fi
122 | echo "Error code $EXIT_CODE :: $OUT, name: '$NAME'"
123 | exit 1
124 | else
125 | if [ -n "$EXPECTED_STRING" ] && [ "$EXPECTED_STRING" = "$OUT" ]; then
126 | # Everything is fine
127 | return 0
128 | fi
129 | echo "Error, didn't get expected info for repo with name '$NAME': '$OUT'"
130 | exit 1
131 | fi
132 | }
133 |
--------------------------------------------------------------------------------
/tests/common-user.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | . "$TESTSDIR/common.sh"
4 |
5 | users_list_count_must_equal() {
6 | local EXPECTED_COUNT="$1"
7 | local USER_LIST
8 | local EXIT_CODE
9 |
10 | set +e
11 | USER_LIST=$(git ss user list)
12 | EXIT_CODE=$?
13 | set -e
14 |
15 | if [ $EXIT_CODE -ne 0 ]; then
16 | if [ "$EXPECTED_COUNT" = "0" ]; then
17 | # Everything is fine
18 | return 0
19 | fi
20 | echo "Error code $EXIT_CODE :: $REPO_LIST"
21 | exit 1
22 | fi
23 | local USER_LIST_COUNT=$(echo "$USER_LIST" | wc -l)
24 | if [ "$USER_LIST_COUNT" != "$EXPECTED_COUNT" ]; then
25 | echo "Error! Too many users available: $USER_LIST_COUNT, expected $EXPECTED_COUNT. Users found:\n$USER_LIST"
26 | exit 1
27 | fi
28 | }
29 |
30 | user_create() {
31 | local NAME="$1"
32 | local PUBLIC_KEY="$2"
33 | set +u
34 | local EXPECTED_ERROR_STRING="$3"
35 | set -u
36 | local OUT
37 | local EXIT_CODE
38 |
39 | set +e
40 | OUT=$(git ss user create -y "$NAME" "$PUBLIC_KEY")
41 | EXIT_CODE=$?
42 | set -e
43 |
44 | if [ $EXIT_CODE -ne 0 ]; then
45 | if [ -n "$EXPECTED_ERROR_STRING" ] && [ "$EXPECTED_ERROR_STRING" = "$OUT" ]; then
46 | # Everything is fine
47 | return 0
48 | fi
49 | echo "Error code $EXIT_CODE :: $OUT, name: '$NAME', public key: '$PUBLIC_KEY'"
50 | exit 1
51 | fi
52 | }
53 |
54 | user_delete() {
55 | local NAME="$1"
56 | set +u
57 | local EXPECTED_ERROR_STRING="$2"
58 | set -u
59 | local OUT
60 | local EXIT_CODE
61 |
62 | set +e
63 | OUT=$(git ss user delete -y "$NAME")
64 | EXIT_CODE=$?
65 | set -e
66 |
67 | if [ $EXIT_CODE -ne 0 ]; then
68 | if [ -n "$EXPECTED_ERROR_STRING" ] && [ "$EXPECTED_ERROR_STRING" = "$OUT" ]; then
69 | # Everything is fine
70 | return 0
71 | fi
72 | echo "Error code $EXIT_CODE :: $OUT, name: '$NAME'"
73 | exit 1
74 | fi
75 | }
76 |
77 | user_info() {
78 | local NAME="$1"
79 | set +u
80 | local EXPECTED_STRING="$2"
81 | set -u
82 | local OUT
83 | local EXIT_CODE
84 |
85 | set +e
86 | OUT=$(git ss user info "$NAME")
87 | EXIT_CODE=$?
88 | set -e
89 |
90 | if [ $EXIT_CODE -ne 0 ]; then
91 | if [ -n "$EXPECTED_STRING" ] && [ "$EXPECTED_STRING" = "$OUT" ]; then
92 | # Everything is fine
93 | return 0
94 | fi
95 | echo "Error code $EXIT_CODE :: $OUT, name: '$NAME'"
96 | exit 1
97 | else
98 | if [ -n "$EXPECTED_STRING" ] && [ "$EXPECTED_STRING" = "$OUT" ]; then
99 | # Everything is fine
100 | return 0
101 | fi
102 | echo "Error, didn't get expected info for user with name '$NAME': '$OUT'"
103 | exit 1
104 | fi
105 | }
106 |
--------------------------------------------------------------------------------
/tests/common.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | set -euf #o pipefail
4 |
--------------------------------------------------------------------------------
/tests/run.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | IM_SURE="--i-know-what-im-doing"
4 | if [ "$1" != "$IM_SURE" ]; then
5 | echo "Please execute $0 $IM_SURE"
6 | exit 1
7 | fi
8 |
9 | export TESTSDIR=$(dirname "$0")
10 |
11 | . "$TESTSDIR/common.sh"
12 |
13 | export USER_NAME="$(whoami)"
14 |
15 | FAILED=false
16 | # TODO(leon): Don't use for loop
17 | for FILE in $(find . -name "*.test" | LC_ALL=C sort); do
18 | set +e
19 | OUT=$("$FILE")
20 | EXIT_CODE=$?
21 | set -e
22 | if [ $EXIT_CODE -ne 0 ]; then
23 | FAILED=true
24 | echo "Test '$FILE' failed with exit code $EXIT_CODE: $OUT"
25 | fi
26 | done
27 |
28 | if [ $FAILED = true ]; then
29 | echo "Some tests failed. :("
30 | exit 1
31 | fi
32 | echo "Yay! Everything works fine :)"
33 |
--------------------------------------------------------------------------------