Browse Source

change readme

Andreas Peters 1 year ago
commit
070167d112

+ 2
- 0
.gitattributes View File

@@ -0,0 +1,2 @@
1
+config.yaml filter=git-crypt diff=git-crypt
2
+*.key filter=git-crypt diff=git-crypt

+ 2
- 0
.gitignore View File

@@ -0,0 +1,2 @@
1
+go-neb.db
2
+log/*.log*

+ 673
- 0
GPL View File

@@ -0,0 +1,673 @@
1
+GNU GENERAL PUBLIC LICENSE
2
+   Version 3, 29 June 2007
3
+
4
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5
+Everyone is permitted to copy and distribute verbatim copies
6
+of this license document, but changing it is not allowed.
7
+
8
+        Preamble
9
+
10
+The GNU General Public License is a free, copyleft license for
11
+software and other kinds of works.
12
+
13
+The licenses for most software and other practical works are designed
14
+to take away your freedom to share and change the works.  By contrast,
15
+the GNU General Public License is intended to guarantee your freedom to
16
+share and change all versions of a program--to make sure it remains free
17
+software for all its users.  We, the Free Software Foundation, use the
18
+GNU General Public License for most of our software; it applies also to
19
+any other work released this way by its authors.  You can apply it to
20
+your programs, too.
21
+
22
+When we speak of free software, we are referring to freedom, not
23
+price.  Our General Public Licenses are designed to make sure that you
24
+have the freedom to distribute copies of free software (and charge for
25
+them if you wish), that you receive source code or can get it if you
26
+want it, that you can change the software or use pieces of it in new
27
+free programs, and that you know you can do these things.
28
+
29
+To protect your rights, we need to prevent others from denying you
30
+these rights or asking you to surrender the rights.  Therefore, you have
31
+certain responsibilities if you distribute copies of the software, or if
32
+you modify it: responsibilities to respect the freedom of others.
33
+
34
+For example, if you distribute copies of such a program, whether
35
+gratis or for a fee, you must pass on to the recipients the same
36
+freedoms that you received.  You must make sure that they, too, receive
37
+or can get the source code.  And you must show them these terms so they
38
+know their rights.
39
+
40
+Developers that use the GNU GPL protect your rights with two steps:
41
+(1) assert copyright on the software, and (2) offer you this License
42
+giving you legal permission to copy, distribute and/or modify it.
43
+
44
+For the developers' and authors' protection, the GPL clearly explains
45
+that there is no warranty for this free software.  For both users' and
46
+authors' sake, the GPL requires that modified versions be marked as
47
+changed, so that their problems will not be attributed erroneously to
48
+authors of previous versions.
49
+
50
+Some devices are designed to deny users access to install or run
51
+modified versions of the software inside them, although the manufacturer
52
+can do so.  This is fundamentally incompatible with the aim of
53
+protecting users' freedom to change the software.  The systematic
54
+pattern of such abuse occurs in the area of products for individuals to
55
+use, which is precisely where it is most unacceptable.  Therefore, we
56
+have designed this version of the GPL to prohibit the practice for those
57
+products.  If such problems arise substantially in other domains, we
58
+stand ready to extend this provision to those domains in future versions
59
+of the GPL, as needed to protect the freedom of users.
60
+
61
+Finally, every program is threatened constantly by software patents.
62
+States should not allow patents to restrict development and use of
63
+software on general-purpose computers, but in those that do, we wish to
64
+avoid the special danger that patents applied to a free program could
65
+make it effectively proprietary.  To prevent this, the GPL assures that
66
+patents cannot be used to render the program non-free.
67
+
68
+The precise terms and conditions for copying, distribution and
69
+modification follow.
70
+
71
+   TERMS AND CONDITIONS
72
+
73
+0. Definitions.
74
+
75
+"This License" refers to version 3 of the GNU General Public License.
76
+
77
+"Copyright" also means copyright-like laws that apply to other kinds of
78
+works, such as semiconductor masks.
79
+
80
+"The Program" refers to any copyrightable work licensed under this
81
+License.  Each licensee is addressed as "you".  "Licensees" and
82
+"recipients" may be individuals or organizations.
83
+
84
+To "modify" a work means to copy from or adapt all or part of the work
85
+in a fashion requiring copyright permission, other than the making of an
86
+exact copy.  The resulting work is called a "modified version" of the
87
+earlier work or a work "based on" the earlier work.
88
+
89
+A "covered work" means either the unmodified Program or a work based
90
+on the Program.
91
+
92
+To "propagate" a work means to do anything with it that, without
93
+permission, would make you directly or secondarily liable for
94
+infringement under applicable copyright law, except executing it on a
95
+computer or modifying a private copy.  Propagation includes copying,
96
+distribution (with or without modification), making available to the
97
+public, and in some countries other activities as well.
98
+
99
+To "convey" a work means any kind of propagation that enables other
100
+parties to make or receive copies.  Mere interaction with a user through
101
+a computer network, with no transfer of a copy, is not conveying.
102
+
103
+An interactive user interface displays "Appropriate Legal Notices"
104
+to the extent that it includes a convenient and prominently visible
105
+feature that (1) displays an appropriate copyright notice, and (2)
106
+tells the user that there is no warranty for the work (except to the
107
+extent that warranties are provided), that licensees may convey the
108
+work under this License, and how to view a copy of this License.  If
109
+the interface presents a list of user commands or options, such as a
110
+menu, a prominent item in the list meets this criterion.
111
+
112
+1. Source Code.
113
+
114
+The "source code" for a work means the preferred form of the work
115
+for making modifications to it.  "Object code" means any non-source
116
+form of a work.
117
+
118
+A "Standard Interface" means an interface that either is an official
119
+standard defined by a recognized standards body, or, in the case of
120
+interfaces specified for a particular programming language, one that
121
+is widely used among developers working in that language.
122
+
123
+The "System Libraries" of an executable work include anything, other
124
+than the work as a whole, that (a) is included in the normal form of
125
+packaging a Major Component, but which is not part of that Major
126
+Component, and (b) serves only to enable use of the work with that
127
+Major Component, or to implement a Standard Interface for which an
128
+implementation is available to the public in source code form.  A
129
+"Major Component", in this context, means a major essential component
130
+(kernel, window system, and so on) of the specific operating system
131
+(if any) on which the executable work runs, or a compiler used to
132
+produce the work, or an object code interpreter used to run it.
133
+
134
+The "Corresponding Source" for a work in object code form means all
135
+the source code needed to generate, install, and (for an executable
136
+work) run the object code and to modify the work, including scripts to
137
+control those activities.  However, it does not include the work's
138
+System Libraries, or general-purpose tools or generally available free
139
+programs which are used unmodified in performing those activities but
140
+which are not part of the work.  For example, Corresponding Source
141
+includes interface definition files associated with source files for
142
+the work, and the source code for shared libraries and dynamically
143
+linked subprograms that the work is specifically designed to require,
144
+such as by intimate data communication or control flow between those
145
+subprograms and other parts of the work.
146
+
147
+The Corresponding Source need not include anything that users
148
+can regenerate automatically from other parts of the Corresponding
149
+Source.
150
+
151
+The Corresponding Source for a work in source code form is that
152
+same work.
153
+
154
+2. Basic Permissions.
155
+
156
+All rights granted under this License are granted for the term of
157
+copyright on the Program, and are irrevocable provided the stated
158
+conditions are met.  This License explicitly affirms your unlimited
159
+permission to run the unmodified Program.  The output from running a
160
+covered work is covered by this License only if the output, given its
161
+content, constitutes a covered work.  This License acknowledges your
162
+rights of fair use or other equivalent, as provided by copyright law.
163
+
164
+You may make, run and propagate covered works that you do not
165
+convey, without conditions so long as your license otherwise remains
166
+in force.  You may convey covered works to others for the sole purpose
167
+of having them make modifications exclusively for you, or provide you
168
+with facilities for running those works, provided that you comply with
169
+the terms of this License in conveying all material for which you do
170
+not control copyright.  Those thus making or running the covered works
171
+for you must do so exclusively on your behalf, under your direction
172
+and control, on terms that prohibit them from making any copies of
173
+your copyrighted material outside their relationship with you.
174
+
175
+Conveying under any other circumstances is permitted solely under
176
+the conditions stated below.  Sublicensing is not allowed; section 10
177
+makes it unnecessary.
178
+
179
+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180
+
181
+No covered work shall be deemed part of an effective technological
182
+measure under any applicable law fulfilling obligations under article
183
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
184
+similar laws prohibiting or restricting circumvention of such
185
+measures.
186
+
187
+When you convey a covered work, you waive any legal power to forbid
188
+circumvention of technological measures to the extent such circumvention
189
+is effected by exercising rights under this License with respect to
190
+the covered work, and you disclaim any intention to limit operation or
191
+modification of the work as a means of enforcing, against the work's
192
+users, your or third parties' legal rights to forbid circumvention of
193
+technological measures.
194
+
195
+4. Conveying Verbatim Copies.
196
+
197
+You may convey verbatim copies of the Program's source code as you
198
+receive it, in any medium, provided that you conspicuously and
199
+appropriately publish on each copy an appropriate copyright notice;
200
+keep intact all notices stating that this License and any
201
+non-permissive terms added in accord with section 7 apply to the code;
202
+keep intact all notices of the absence of any warranty; and give all
203
+recipients a copy of this License along with the Program.
204
+
205
+You may charge any price or no price for each copy that you convey,
206
+and you may offer support or warranty protection for a fee.
207
+
208
+5. Conveying Modified Source Versions.
209
+
210
+You may convey a work based on the Program, or the modifications to
211
+produce it from the Program, in the form of source code under the
212
+terms of section 4, provided that you also meet all of these conditions:
213
+
214
+a) The work must carry prominent notices stating that you modified
215
+it, and giving a relevant date.
216
+
217
+b) The work must carry prominent notices stating that it is
218
+released under this License and any conditions added under section
219
+7.  This requirement modifies the requirement in section 4 to
220
+"keep intact all notices".
221
+
222
+c) You must license the entire work, as a whole, under this
223
+License to anyone who comes into possession of a copy.  This
224
+License will therefore apply, along with any applicable section 7
225
+additional terms, to the whole of the work, and all its parts,
226
+regardless of how they are packaged.  This License gives no
227
+permission to license the work in any other way, but it does not
228
+invalidate such permission if you have separately received it.
229
+
230
+d) If the work has interactive user interfaces, each must display
231
+Appropriate Legal Notices; however, if the Program has interactive
232
+interfaces that do not display Appropriate Legal Notices, your
233
+work need not make them do so.
234
+
235
+A compilation of a covered work with other separate and independent
236
+works, which are not by their nature extensions of the covered work,
237
+and which are not combined with it such as to form a larger program,
238
+in or on a volume of a storage or distribution medium, is called an
239
+"aggregate" if the compilation and its resulting copyright are not
240
+used to limit the access or legal rights of the compilation's users
241
+beyond what the individual works permit.  Inclusion of a covered work
242
+in an aggregate does not cause this License to apply to the other
243
+parts of the aggregate.
244
+
245
+6. Conveying Non-Source Forms.
246
+
247
+You may convey a covered work in object code form under the terms
248
+of sections 4 and 5, provided that you also convey the
249
+machine-readable Corresponding Source under the terms of this License,
250
+in one of these ways:
251
+
252
+a) Convey the object code in, or embodied in, a physical product
253
+(including a physical distribution medium), accompanied by the
254
+Corresponding Source fixed on a durable physical medium
255
+customarily used for software interchange.
256
+
257
+b) Convey the object code in, or embodied in, a physical product
258
+(including a physical distribution medium), accompanied by a
259
+written offer, valid for at least three years and valid for as
260
+long as you offer spare parts or customer support for that product
261
+model, to give anyone who possesses the object code either (1) a
262
+copy of the Corresponding Source for all the software in the
263
+product that is covered by this License, on a durable physical
264
+medium customarily used for software interchange, for a price no
265
+more than your reasonable cost of physically performing this
266
+conveying of source, or (2) access to copy the
267
+Corresponding Source from a network server at no charge.
268
+
269
+c) Convey individual copies of the object code with a copy of the
270
+written offer to provide the Corresponding Source.  This
271
+alternative is allowed only occasionally and noncommercially, and
272
+only if you received the object code with such an offer, in accord
273
+with subsection 6b.
274
+
275
+d) Convey the object code by offering access from a designated
276
+place (gratis or for a charge), and offer equivalent access to the
277
+Corresponding Source in the same way through the same place at no
278
+further charge.  You need not require recipients to copy the
279
+Corresponding Source along with the object code.  If the place to
280
+copy the object code is a network server, the Corresponding Source
281
+may be on a different server (operated by you or a third party)
282
+that supports equivalent copying facilities, provided you maintain
283
+clear directions next to the object code saying where to find the
284
+Corresponding Source.  Regardless of what server hosts the
285
+Corresponding Source, you remain obligated to ensure that it is
286
+available for as long as needed to satisfy these requirements.
287
+
288
+e) Convey the object code using peer-to-peer transmission, provided
289
+you inform other peers where the object code and Corresponding
290
+Source of the work are being offered to the general public at no
291
+charge under subsection 6d.
292
+
293
+A separable portion of the object code, whose source code is excluded
294
+from the Corresponding Source as a System Library, need not be
295
+included in conveying the object code work.
296
+
297
+A "User Product" is either (1) a "consumer product", which means any
298
+tangible personal property which is normally used for personal, family,
299
+or household purposes, or (2) anything designed or sold for incorporation
300
+into a dwelling.  In determining whether a product is a consumer product,
301
+doubtful cases shall be resolved in favor of coverage.  For a particular
302
+product received by a particular user, "normally used" refers to a
303
+typical or common use of that class of product, regardless of the status
304
+of the particular user or of the way in which the particular user
305
+actually uses, or expects or is expected to use, the product.  A product
306
+is a consumer product regardless of whether the product has substantial
307
+commercial, industrial or non-consumer uses, unless such uses represent
308
+the only significant mode of use of the product.
309
+
310
+"Installation Information" for a User Product means any methods,
311
+procedures, authorization keys, or other information required to install
312
+and execute modified versions of a covered work in that User Product from
313
+a modified version of its Corresponding Source.  The information must
314
+suffice to ensure that the continued functioning of the modified object
315
+code is in no case prevented or interfered with solely because
316
+modification has been made.
317
+
318
+If you convey an object code work under this section in, or with, or
319
+specifically for use in, a User Product, and the conveying occurs as
320
+part of a transaction in which the right of possession and use of the
321
+User Product is transferred to the recipient in perpetuity or for a
322
+fixed term (regardless of how the transaction is characterized), the
323
+Corresponding Source conveyed under this section must be accompanied
324
+by the Installation Information.  But this requirement does not apply
325
+if neither you nor any third party retains the ability to install
326
+modified object code on the User Product (for example, the work has
327
+been installed in ROM).
328
+
329
+The requirement to provide Installation Information does not include a
330
+requirement to continue to provide support service, warranty, or updates
331
+for a work that has been modified or installed by the recipient, or for
332
+the User Product in which it has been modified or installed.  Access to a
333
+network may be denied when the modification itself materially and
334
+adversely affects the operation of the network or violates the rules and
335
+protocols for communication across the network.
336
+
337
+Corresponding Source conveyed, and Installation Information provided,
338
+in accord with this section must be in a format that is publicly
339
+documented (and with an implementation available to the public in
340
+source code form), and must require no special password or key for
341
+unpacking, reading or copying.
342
+
343
+7. Additional Terms.
344
+
345
+"Additional permissions" are terms that supplement the terms of this
346
+License by making exceptions from one or more of its conditions.
347
+Additional permissions that are applicable to the entire Program shall
348
+be treated as though they were included in this License, to the extent
349
+that they are valid under applicable law.  If additional permissions
350
+apply only to part of the Program, that part may be used separately
351
+under those permissions, but the entire Program remains governed by
352
+this License without regard to the additional permissions.
353
+
354
+When you convey a copy of a covered work, you may at your option
355
+remove any additional permissions from that copy, or from any part of
356
+it.  (Additional permissions may be written to require their own
357
+removal in certain cases when you modify the work.)  You may place
358
+additional permissions on material, added by you to a covered work,
359
+for which you have or can give appropriate copyright permission.
360
+
361
+Notwithstanding any other provision of this License, for material you
362
+add to a covered work, you may (if authorized by the copyright holders of
363
+that material) supplement the terms of this License with terms:
364
+
365
+a) Disclaiming warranty or limiting liability differently from the
366
+terms of sections 15 and 16 of this License; or
367
+
368
+b) Requiring preservation of specified reasonable legal notices or
369
+author attributions in that material or in the Appropriate Legal
370
+Notices displayed by works containing it; or
371
+
372
+c) Prohibiting misrepresentation of the origin of that material, or
373
+requiring that modified versions of such material be marked in
374
+reasonable ways as different from the original version; or
375
+
376
+d) Limiting the use for publicity purposes of names of licensors or
377
+authors of the material; or
378
+
379
+e) Declining to grant rights under trademark law for use of some
380
+trade names, trademarks, or service marks; or
381
+
382
+f) Requiring indemnification of licensors and authors of that
383
+material by anyone who conveys the material (or modified versions of
384
+it) with contractual assumptions of liability to the recipient, for
385
+any liability that these contractual assumptions directly impose on
386
+those licensors and authors.
387
+
388
+All other non-permissive additional terms are considered "further
389
+restrictions" within the meaning of section 10.  If the Program as you
390
+received it, or any part of it, contains a notice stating that it is
391
+governed by this License along with a term that is a further
392
+restriction, you may remove that term.  If a license document contains
393
+a further restriction but permits relicensing or conveying under this
394
+License, you may add to a covered work material governed by the terms
395
+of that license document, provided that the further restriction does
396
+not survive such relicensing or conveying.
397
+
398
+If you add terms to a covered work in accord with this section, you
399
+must place, in the relevant source files, a statement of the
400
+additional terms that apply to those files, or a notice indicating
401
+where to find the applicable terms.
402
+
403
+Additional terms, permissive or non-permissive, may be stated in the
404
+form of a separately written license, or stated as exceptions;
405
+the above requirements apply either way.
406
+
407
+8. Termination.
408
+
409
+You may not propagate or modify a covered work except as expressly
410
+provided under this License.  Any attempt otherwise to propagate or
411
+modify it is void, and will automatically terminate your rights under
412
+this License (including any patent licenses granted under the third
413
+paragraph of section 11).
414
+
415
+However, if you cease all violation of this License, then your
416
+license from a particular copyright holder is reinstated (a)
417
+provisionally, unless and until the copyright holder explicitly and
418
+finally terminates your license, and (b) permanently, if the copyright
419
+holder fails to notify you of the violation by some reasonable means
420
+prior to 60 days after the cessation.
421
+
422
+Moreover, your license from a particular copyright holder is
423
+reinstated permanently if the copyright holder notifies you of the
424
+violation by some reasonable means, this is the first time you have
425
+received notice of violation of this License (for any work) from that
426
+copyright holder, and you cure the violation prior to 30 days after
427
+your receipt of the notice.
428
+
429
+Termination of your rights under this section does not terminate the
430
+licenses of parties who have received copies or rights from you under
431
+this License.  If your rights have been terminated and not permanently
432
+reinstated, you do not qualify to receive new licenses for the same
433
+material under section 10.
434
+
435
+9. Acceptance Not Required for Having Copies.
436
+
437
+You are not required to accept this License in order to receive or
438
+run a copy of the Program.  Ancillary propagation of a covered work
439
+occurring solely as a consequence of using peer-to-peer transmission
440
+to receive a copy likewise does not require acceptance.  However,
441
+nothing other than this License grants you permission to propagate or
442
+modify any covered work.  These actions infringe copyright if you do
443
+not accept this License.  Therefore, by modifying or propagating a
444
+covered work, you indicate your acceptance of this License to do so.
445
+
446
+10. Automatic Licensing of Downstream Recipients.
447
+
448
+Each time you convey a covered work, the recipient automatically
449
+receives a license from the original licensors, to run, modify and
450
+propagate that work, subject to this License.  You are not responsible
451
+for enforcing compliance by third parties with this License.
452
+
453
+An "entity transaction" is a transaction transferring control of an
454
+organization, or substantially all assets of one, or subdividing an
455
+organization, or merging organizations.  If propagation of a covered
456
+work results from an entity transaction, each party to that
457
+transaction who receives a copy of the work also receives whatever
458
+licenses to the work the party's predecessor in interest had or could
459
+give under the previous paragraph, plus a right to possession of the
460
+Corresponding Source of the work from the predecessor in interest, if
461
+the predecessor has it or can get it with reasonable efforts.
462
+
463
+You may not impose any further restrictions on the exercise of the
464
+rights granted or affirmed under this License.  For example, you may
465
+not impose a license fee, royalty, or other charge for exercise of
466
+rights granted under this License, and you may not initiate litigation
467
+(including a cross-claim or counterclaim in a lawsuit) alleging that
468
+any patent claim is infringed by making, using, selling, offering for
469
+sale, or importing the Program or any portion of it.
470
+
471
+11. Patents.
472
+
473
+A "contributor" is a copyright holder who authorizes use under this
474
+License of the Program or a work on which the Program is based.  The
475
+work thus licensed is called the contributor's "contributor version".
476
+
477
+A contributor's "essential patent claims" are all patent claims
478
+owned or controlled by the contributor, whether already acquired or
479
+hereafter acquired, that would be infringed by some manner, permitted
480
+by this License, of making, using, or selling its contributor version,
481
+but do not include claims that would be infringed only as a
482
+consequence of further modification of the contributor version.  For
483
+purposes of this definition, "control" includes the right to grant
484
+patent sublicenses in a manner consistent with the requirements of
485
+this License.
486
+
487
+Each contributor grants you a non-exclusive, worldwide, royalty-free
488
+patent license under the contributor's essential patent claims, to
489
+make, use, sell, offer for sale, import and otherwise run, modify and
490
+propagate the contents of its contributor version.
491
+
492
+In the following three paragraphs, a "patent license" is any express
493
+agreement or commitment, however denominated, not to enforce a patent
494
+(such as an express permission to practice a patent or covenant not to
495
+sue for patent infringement).  To "grant" such a patent license to a
496
+party means to make such an agreement or commitment not to enforce a
497
+patent against the party.
498
+
499
+If you convey a covered work, knowingly relying on a patent license,
500
+and the Corresponding Source of the work is not available for anyone
501
+to copy, free of charge and under the terms of this License, through a
502
+publicly available network server or other readily accessible means,
503
+then you must either (1) cause the Corresponding Source to be so
504
+available, or (2) arrange to deprive yourself of the benefit of the
505
+patent license for this particular work, or (3) arrange, in a manner
506
+consistent with the requirements of this License, to extend the patent
507
+license to downstream recipients.  "Knowingly relying" means you have
508
+actual knowledge that, but for the patent license, your conveying the
509
+covered work in a country, or your recipient's use of the covered work
510
+in a country, would infringe one or more identifiable patents in that
511
+country that you have reason to believe are valid.
512
+
513
+If, pursuant to or in connection with a single transaction or
514
+arrangement, you convey, or propagate by procuring conveyance of, a
515
+covered work, and grant a patent license to some of the parties
516
+receiving the covered work authorizing them to use, propagate, modify
517
+or convey a specific copy of the covered work, then the patent license
518
+you grant is automatically extended to all recipients of the covered
519
+work and works based on it.
520
+
521
+A patent license is "discriminatory" if it does not include within
522
+the scope of its coverage, prohibits the exercise of, or is
523
+conditioned on the non-exercise of one or more of the rights that are
524
+specifically granted under this License.  You may not convey a covered
525
+work if you are a party to an arrangement with a third party that is
526
+in the business of distributing software, under which you make payment
527
+to the third party based on the extent of your activity of conveying
528
+the work, and under which the third party grants, to any of the
529
+parties who would receive the covered work from you, a discriminatory
530
+patent license (a) in connection with copies of the covered work
531
+conveyed by you (or copies made from those copies), or (b) primarily
532
+for and in connection with specific products or compilations that
533
+contain the covered work, unless you entered into that arrangement,
534
+or that patent license was granted, prior to 28 March 2007.
535
+
536
+Nothing in this License shall be construed as excluding or limiting
537
+any implied license or other defenses to infringement that may
538
+otherwise be available to you under applicable patent law.
539
+
540
+12. No Surrender of Others' Freedom.
541
+
542
+If conditions are imposed on you (whether by court order, agreement or
543
+otherwise) that contradict the conditions of this License, they do not
544
+excuse you from the conditions of this License.  If you cannot convey a
545
+covered work so as to satisfy simultaneously your obligations under this
546
+License and any other pertinent obligations, then as a consequence you may
547
+not convey it at all.  For example, if you agree to terms that obligate you
548
+to collect a royalty for further conveying from those to whom you convey
549
+the Program, the only way you could satisfy both those terms and this
550
+License would be to refrain entirely from conveying the Program.
551
+
552
+13. Use with the GNU Affero General Public License.
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 Affero 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 special requirements of the GNU Affero General Public License,
560
+section 13, concerning interaction through a network will apply to the
561
+combination as such.
562
+
563
+14. Revised Versions of this License.
564
+
565
+The Free Software Foundation may publish revised and/or new versions of
566
+the GNU General Public License from time to time.  Such new versions will
567
+be similar in spirit to the present version, but may differ in detail to
568
+address new problems or concerns.
569
+
570
+Each version is given a distinguishing version number.  If the
571
+Program specifies that a certain numbered version of the GNU General
572
+Public License "or any later version" applies to it, you have the
573
+option of following the terms and conditions either of that numbered
574
+version or of any later version published by the Free Software
575
+Foundation.  If the Program does not specify a version number of the
576
+GNU General Public License, you may choose any version ever published
577
+by the Free Software Foundation.
578
+
579
+If the Program specifies that a proxy can decide which future
580
+versions of the GNU General Public License can be used, that proxy's
581
+public statement of acceptance of a version permanently authorizes you
582
+to choose that version for the Program.
583
+
584
+Later license versions may give you additional or different
585
+permissions.  However, no additional obligations are imposed on any
586
+author or copyright holder as a result of your choosing to follow a
587
+later version.
588
+
589
+15. Disclaimer of Warranty.
590
+
591
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599
+
600
+16. Limitation of Liability.
601
+
602
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610
+SUCH DAMAGES.
611
+
612
+17. Interpretation of Sections 15 and 16.
613
+
614
+If the disclaimer of warranty and limitation of liability provided
615
+above cannot be given local legal effect according to their terms,
616
+reviewing courts shall apply local law that most closely approximates
617
+an absolute waiver of all civil liability in connection with the
618
+Program, unless a warranty or assumption of liability accompanies a
619
+copy of the Program in return for a fee.
620
+
621
+ END OF TERMS AND CONDITIONS
622
+
623
+How to Apply These Terms to Your New Programs
624
+
625
+If you develop a new program, and you want it to be of the greatest
626
+possible use to the public, the best way to achieve this is to make it
627
+free software which everyone can redistribute and change under these terms.
628
+
629
+To do so, attach the following notices to the program.  It is safest
630
+to attach them to the start of each source file to most effectively
631
+state the exclusion of warranty; and each file should have at least
632
+the "copyright" line and a pointer to where the full notice is found.
633
+
634
+Copyright (C) 2017 AVENTER UG (haftungsbeschraenkt)
635
+
636
+This program is free software: you can redistribute it and/or modify
637
+it under the terms of the GNU General Public License as published by
638
+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 General Public License for more details.
645
+
646
+You should have received a copy of the GNU General Public License
647
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
648
+
649
+Also add information on how to contact you by electronic and paper mail.
650
+
651
+If the program does terminal interaction, make it output a short
652
+notice like this when it starts in an interactive mode:
653
+
654
+Copyright (C) 2017 AVENTER UG (haftungsbeschraenkt)
655
+This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
656
+This is free software, and you are welcome to redistribute it
657
+under certain conditions; type `show c' for details.
658
+
659
+The hypothetical commands `show w' and `show c' should show the appropriate
660
+parts of the General Public License.  Of course, your program's commands
661
+might be different; for a GUI interface, you would use an "about box".
662
+
663
+You should also get your employer (if you work as a programmer) or school,
664
+if any, to sign a "copyright disclaimer" for the program, if necessary.
665
+For more information on this, and how to apply and follow the GNU GPL, see
666
+<http://www.gnu.org/licenses/>.
667
+
668
+The GNU General Public License does not permit incorporating your program
669
+into proprietary programs.  If your program is a subroutine library, you
670
+may consider it more useful to permit linking proprietary applications with
671
+the library.  If this is what you want to do, use the GNU Lesser General
672
+Public License instead of this License.  But first, please read
673
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

+ 675
- 0
LICENSE View File

@@ -0,0 +1,675 @@
1
+GNU GENERAL PUBLIC LICENSE
2
+   Version 3, 29 June 2007
3
+
4
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5
+Everyone is permitted to copy and distribute verbatim copies
6
+of this license document, but changing it is not allowed.
7
+
8
+        Preamble
9
+
10
+The GNU General Public License is a free, copyleft license for
11
+software and other kinds of works.
12
+
13
+The licenses for most software and other practical works are designed
14
+to take away your freedom to share and change the works.  By contrast,
15
+the GNU General Public License is intended to guarantee your freedom to
16
+share and change all versions of a program--to make sure it remains free
17
+software for all its users.  We, the Free Software Foundation, use the
18
+GNU General Public License for most of our software; it applies also to
19
+any other work released this way by its authors.  You can apply it to
20
+your programs, too.
21
+
22
+When we speak of free software, we are referring to freedom, not
23
+price.  Our General Public Licenses are designed to make sure that you
24
+have the freedom to distribute copies of free software (and charge for
25
+them if you wish), that you receive source code or can get it if you
26
+want it, that you can change the software or use pieces of it in new
27
+free programs, and that you know you can do these things.
28
+
29
+To protect your rights, we need to prevent others from denying you
30
+these rights or asking you to surrender the rights.  Therefore, you have
31
+certain responsibilities if you distribute copies of the software, or if
32
+you modify it: responsibilities to respect the freedom of others.
33
+
34
+For example, if you distribute copies of such a program, whether
35
+gratis or for a fee, you must pass on to the recipients the same
36
+freedoms that you received.  You must make sure that they, too, receive
37
+or can get the source code.  And you must show them these terms so they
38
+know their rights.
39
+
40
+Developers that use the GNU GPL protect your rights with two steps:
41
+(1) assert copyright on the software, and (2) offer you this License
42
+giving you legal permission to copy, distribute and/or modify it.
43
+
44
+For the developers' and authors' protection, the GPL clearly explains
45
+that there is no warranty for this free software.  For both users' and
46
+authors' sake, the GPL requires that modified versions be marked as
47
+changed, so that their problems will not be attributed erroneously to
48
+authors of previous versions.
49
+
50
+Some devices are designed to deny users access to install or run
51
+modified versions of the software inside them, although the manufacturer
52
+can do so.  This is fundamentally incompatible with the aim of
53
+protecting users' freedom to change the software.  The systematic
54
+pattern of such abuse occurs in the area of products for individuals to
55
+use, which is precisely where it is most unacceptable.  Therefore, we
56
+have designed this version of the GPL to prohibit the practice for those
57
+products.  If such problems arise substantially in other domains, we
58
+stand ready to extend this provision to those domains in future versions
59
+of the GPL, as needed to protect the freedom of users.
60
+
61
+Finally, every program is threatened constantly by software patents.
62
+States should not allow patents to restrict development and use of
63
+software on general-purpose computers, but in those that do, we wish to
64
+avoid the special danger that patents applied to a free program could
65
+make it effectively proprietary.  To prevent this, the GPL assures that
66
+patents cannot be used to render the program non-free.
67
+
68
+The precise terms and conditions for copying, distribution and
69
+modification follow.
70
+
71
+   TERMS AND CONDITIONS
72
+
73
+0. Definitions.
74
+
75
+"This License" refers to version 3 of the GNU General Public License.
76
+
77
+"Copyright" also means copyright-like laws that apply to other kinds of
78
+works, such as semiconductor masks.
79
+
80
+"The Program" refers to any copyrightable work licensed under this
81
+License.  Each licensee is addressed as "you".  "Licensees" and
82
+"recipients" may be individuals or organizations.
83
+
84
+To "modify" a work means to copy from or adapt all or part of the work
85
+in a fashion requiring copyright permission, other than the making of an
86
+exact copy.  The resulting work is called a "modified version" of the
87
+earlier work or a work "based on" the earlier work.
88
+
89
+A "covered work" means either the unmodified Program or a work based
90
+on the Program.
91
+
92
+To "propagate" a work means to do anything with it that, without
93
+permission, would make you directly or secondarily liable for
94
+infringement under applicable copyright law, except executing it on a
95
+computer or modifying a private copy.  Propagation includes copying,
96
+distribution (with or without modification), making available to the
97
+public, and in some countries other activities as well.
98
+
99
+To "convey" a work means any kind of propagation that enables other
100
+parties to make or receive copies.  Mere interaction with a user through
101
+a computer network, with no transfer of a copy, is not conveying.
102
+
103
+An interactive user interface displays "Appropriate Legal Notices"
104
+to the extent that it includes a convenient and prominently visible
105
+feature that (1) displays an appropriate copyright notice, and (2)
106
+tells the user that there is no warranty for the work (except to the
107
+extent that warranties are provided), that licensees may convey the
108
+work under this License, and how to view a copy of this License.  If
109
+the interface presents a list of user commands or options, such as a
110
+menu, a prominent item in the list meets this criterion.
111
+
112
+1. Source Code.
113
+
114
+The "source code" for a work means the preferred form of the work
115
+for making modifications to it.  "Object code" means any non-source
116
+form of a work.
117
+
118
+A "Standard Interface" means an interface that either is an official
119
+standard defined by a recognized standards body, or, in the case of
120
+interfaces specified for a particular programming language, one that
121
+is widely used among developers working in that language.
122
+
123
+The "System Libraries" of an executable work include anything, other
124
+than the work as a whole, that (a) is included in the normal form of
125
+packaging a Major Component, but which is not part of that Major
126
+Component, and (b) serves only to enable use of the work with that
127
+Major Component, or to implement a Standard Interface for which an
128
+implementation is available to the public in source code form.  A
129
+"Major Component", in this context, means a major essential component
130
+(kernel, window system, and so on) of the specific operating system
131
+(if any) on which the executable work runs, or a compiler used to
132
+produce the work, or an object code interpreter used to run it.
133
+
134
+The "Corresponding Source" for a work in object code form means all
135
+the source code needed to generate, install, and (for an executable
136
+work) run the object code and to modify the work, including scripts to
137
+control those activities.  However, it does not include the work's
138
+System Libraries, or general-purpose tools or generally available free
139
+programs which are used unmodified in performing those activities but
140
+which are not part of the work.  For example, Corresponding Source
141
+includes interface definition files associated with source files for
142
+the work, and the source code for shared libraries and dynamically
143
+linked subprograms that the work is specifically designed to require,
144
+such as by intimate data communication or control flow between those
145
+subprograms and other parts of the work.
146
+
147
+The Corresponding Source need not include anything that users
148
+can regenerate automatically from other parts of the Corresponding
149
+Source.
150
+
151
+The Corresponding Source for a work in source code form is that
152
+same work.
153
+
154
+2. Basic Permissions.
155
+
156
+All rights granted under this License are granted for the term of
157
+copyright on the Program, and are irrevocable provided the stated
158
+conditions are met.  This License explicitly affirms your unlimited
159
+permission to run the unmodified Program.  The output from running a
160
+covered work is covered by this License only if the output, given its
161
+content, constitutes a covered work.  This License acknowledges your
162
+rights of fair use or other equivalent, as provided by copyright law.
163
+
164
+You may make, run and propagate covered works that you do not
165
+convey, without conditions so long as your license otherwise remains
166
+in force.  You may convey covered works to others for the sole purpose
167
+of having them make modifications exclusively for you, or provide you
168
+with facilities for running those works, provided that you comply with
169
+the terms of this License in conveying all material for which you do
170
+not control copyright.  Those thus making or running the covered works
171
+for you must do so exclusively on your behalf, under your direction
172
+and control, on terms that prohibit them from making any copies of
173
+your copyrighted material outside their relationship with you.
174
+
175
+Conveying under any other circumstances is permitted solely under
176
+the conditions stated below.  Sublicensing is not allowed; section 10
177
+makes it unnecessary.
178
+
179
+3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180
+
181
+No covered work shall be deemed part of an effective technological
182
+measure under any applicable law fulfilling obligations under article
183
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
184
+similar laws prohibiting or restricting circumvention of such
185
+measures.
186
+
187
+When you convey a covered work, you waive any legal power to forbid
188
+circumvention of technological measures to the extent such circumvention
189
+is effected by exercising rights under this License with respect to
190
+the covered work, and you disclaim any intention to limit operation or
191
+modification of the work as a means of enforcing, against the work's
192
+users, your or third parties' legal rights to forbid circumvention of
193
+technological measures.
194
+
195
+4. Conveying Verbatim Copies.
196
+
197
+You may convey verbatim copies of the Program's source code as you
198
+receive it, in any medium, provided that you conspicuously and
199
+appropriately publish on each copy an appropriate copyright notice;
200
+keep intact all notices stating that this License and any
201
+non-permissive terms added in accord with section 7 apply to the code;
202
+keep intact all notices of the absence of any warranty; and give all
203
+recipients a copy of this License along with the Program.
204
+
205
+You may charge any price or no price for each copy that you convey,
206
+and you may offer support or warranty protection for a fee.
207
+
208
+5. Conveying Modified Source Versions.
209
+
210
+You may convey a work based on the Program, or the modifications to
211
+produce it from the Program, in the form of source code under the
212
+terms of section 4, provided that you also meet all of these conditions:
213
+
214
+a) The work must carry prominent notices stating that you modified
215
+it, and giving a relevant date.
216
+
217
+b) The work must carry prominent notices stating that it is
218
+released under this License and any conditions added under section
219
+7.  This requirement modifies the requirement in section 4 to
220
+"keep intact all notices".
221
+
222
+c) You must license the entire work, as a whole, under this
223
+License to anyone who comes into possession of a copy.  This
224
+License will therefore apply, along with any applicable section 7
225
+additional terms, to the whole of the work, and all its parts,
226
+regardless of how they are packaged.  This License gives no
227
+permission to license the work in any other way, but it does not
228
+invalidate such permission if you have separately received it.
229
+
230
+d) If the work has interactive user interfaces, each must display
231
+Appropriate Legal Notices; however, if the Program has interactive
232
+interfaces that do not display Appropriate Legal Notices, your
233
+work need not make them do so.
234
+
235
+A compilation of a covered work with other separate and independent
236
+works, which are not by their nature extensions of the covered work,
237
+and which are not combined with it such as to form a larger program,
238
+in or on a volume of a storage or distribution medium, is called an
239
+"aggregate" if the compilation and its resulting copyright are not
240
+used to limit the access or legal rights of the compilation's users
241
+beyond what the individual works permit.  Inclusion of a covered work
242
+in an aggregate does not cause this License to apply to the other
243
+parts of the aggregate.
244
+
245
+6. Conveying Non-Source Forms.
246
+
247
+You may convey a covered work in object code form under the terms
248
+of sections 4 and 5, provided that you also convey the
249
+machine-readable Corresponding Source under the terms of this License,
250
+in one of these ways:
251
+
252
+a) Convey the object code in, or embodied in, a physical product
253
+(including a physical distribution medium), accompanied by the
254
+Corresponding Source fixed on a durable physical medium
255
+customarily used for software interchange.
256
+
257
+b) Convey the object code in, or embodied in, a physical product
258
+(including a physical distribution medium), accompanied by a
259
+written offer, valid for at least three years and valid for as
260
+long as you offer spare parts or customer support for that product
261
+model, to give anyone who possesses the object code either (1) a
262
+copy of the Corresponding Source for all the software in the
263
+product that is covered by this License, on a durable physical
264
+medium customarily used for software interchange, for a price no
265
+more than your reasonable cost of physically performing this
266
+conveying of source, or (2) access to copy the
267
+Corresponding Source from a network server at no charge.
268
+
269
+c) Convey individual copies of the object code with a copy of the
270
+written offer to provide the Corresponding Source.  This
271
+alternative is allowed only occasionally and noncommercially, and
272
+only if you received the object code with such an offer, in accord
273
+with subsection 6b.
274
+
275
+d) Convey the object code by offering access from a designated
276
+place (gratis or for a charge), and offer equivalent access to the
277
+Corresponding Source in the same way through the same place at no
278
+further charge.  You need not require recipients to copy the
279
+Corresponding Source along with the object code.  If the place to
280
+copy the object code is a network server, the Corresponding Source
281
+may be on a different server (operated by you or a third party)
282
+that supports equivalent copying facilities, provided you maintain
283
+clear directions next to the object code saying where to find the
284
+Corresponding Source.  Regardless of what server hosts the
285
+Corresponding Source, you remain obligated to ensure that it is
286
+available for as long as needed to satisfy these requirements.
287
+
288
+e) Convey the object code using peer-to-peer transmission, provided
289
+you inform other peers where the object code and Corresponding
290
+Source of the work are being offered to the general public at no
291
+charge under subsection 6d.
292
+
293
+A separable portion of the object code, whose source code is excluded
294
+from the Corresponding Source as a System Library, need not be
295
+included in conveying the object code work.
296
+
297
+A "User Product" is either (1) a "consumer product", which means any
298
+tangible personal property which is normally used for personal, family,
299
+or household purposes, or (2) anything designed or sold for incorporation
300
+into a dwelling.  In determining whether a product is a consumer product,
301
+doubtful cases shall be resolved in favor of coverage.  For a particular
302
+product received by a particular user, "normally used" refers to a
303
+typical or common use of that class of product, regardless of the status
304
+of the particular user or of the way in which the particular user
305
+actually uses, or expects or is expected to use, the product.  A product
306
+is a consumer product regardless of whether the product has substantial
307
+commercial, industrial or non-consumer uses, unless such uses represent
308
+the only significant mode of use of the product.
309
+
310
+"Installation Information" for a User Product means any methods,
311
+procedures, authorization keys, or other information required to install
312
+and execute modified versions of a covered work in that User Product from
313
+a modified version of its Corresponding Source.  The information must
314
+suffice to ensure that the continued functioning of the modified object
315
+code is in no case prevented or interfered with solely because
316
+modification has been made.
317
+
318
+If you convey an object code work under this section in, or with, or
319
+specifically for use in, a User Product, and the conveying occurs as
320
+part of a transaction in which the right of possession and use of the
321
+User Product is transferred to the recipient in perpetuity or for a
322
+fixed term (regardless of how the transaction is characterized), the
323
+Corresponding Source conveyed under this section must be accompanied
324
+by the Installation Information.  But this requirement does not apply
325
+if neither you nor any third party retains the ability to install
326
+modified object code on the User Product (for example, the work has
327
+been installed in ROM).
328
+
329
+The requirement to provide Installation Information does not include a
330
+requirement to continue to provide support service, warranty, or updates
331
+for a work that has been modified or installed by the recipient, or for
332
+the User Product in which it has been modified or installed.  Access to a
333
+network may be denied when the modification itself materially and
334
+adversely affects the operation of the network or violates the rules and
335
+protocols for communication across the network.
336
+
337
+Corresponding Source conveyed, and Installation Information provided,
338
+in accord with this section must be in a format that is publicly
339
+documented (and with an implementation available to the public in
340
+source code form), and must require no special password or key for
341
+unpacking, reading or copying.
342
+
343
+7. Additional Terms.
344
+
345
+"Additional permissions" are terms that supplement the terms of this
346
+License by making exceptions from one or more of its conditions.
347
+Additional permissions that are applicable to the entire Program shall
348
+be treated as though they were included in this License, to the extent
349
+that they are valid under applicable law.  If additional permissions
350
+apply only to part of the Program, that part may be used separately
351
+under those permissions, but the entire Program remains governed by
352
+this License without regard to the additional permissions.
353
+
354
+When you convey a copy of a covered work, you may at your option
355
+remove any additional permissions from that copy, or from any part of
356
+it.  (Additional permissions may be written to require their own
357
+removal in certain cases when you modify the work.)  You may place
358
+additional permissions on material, added by you to a covered work,
359
+for which you have or can give appropriate copyright permission.
360
+
361
+Notwithstanding any other provision of this License, for material you
362
+add to a covered work, you may (if authorized by the copyright holders of
363
+that material) supplement the terms of this License with terms:
364
+
365
+a) Disclaiming warranty or limiting liability differently from the
366
+terms of sections 15 and 16 of this License; or
367
+
368
+b) Requiring preservation of specified reasonable legal notices or
369
+author attributions in that material or in the Appropriate Legal
370
+Notices displayed by works containing it; or
371
+
372
+c) Prohibiting misrepresentation of the origin of that material, or
373
+requiring that modified versions of such material be marked in
374
+reasonable ways as different from the original version; or
375
+
376
+d) Limiting the use for publicity purposes of names of licensors or
377
+authors of the material; or
378
+
379
+e) Declining to grant rights under trademark law for use of some
380
+trade names, trademarks, or service marks; or
381
+
382
+f) Requiring indemnification of licensors and authors of that
383
+material by anyone who conveys the material (or modified versions of
384
+it) with contractual assumptions of liability to the recipient, for
385
+any liability that these contractual assumptions directly impose on
386
+those licensors and authors.
387
+
388
+All other non-permissive additional terms are considered "further
389
+restrictions" within the meaning of section 10.  If the Program as you
390
+received it, or any part of it, contains a notice stating that it is
391
+governed by this License along with a term that is a further
392
+restriction, you may remove that term.  If a license document contains
393
+a further restriction but permits relicensing or conveying under this
394
+License, you may add to a covered work material governed by the terms
395
+of that license document, provided that the further restriction does
396
+not survive such relicensing or conveying.
397
+
398
+If you add terms to a covered work in accord with this section, you
399
+must place, in the relevant source files, a statement of the
400
+additional terms that apply to those files, or a notice indicating
401
+where to find the applicable terms.
402
+
403
+Additional terms, permissive or non-permissive, may be stated in the
404
+form of a separately written license, or stated as exceptions;
405
+the above requirements apply either way.
406
+
407
+8. Termination.
408
+
409
+You may not propagate or modify a covered work except as expressly
410
+provided under this License.  Any attempt otherwise to propagate or
411
+modify it is void, and will automatically terminate your rights under
412
+this License (including any patent licenses granted under the third
413
+paragraph of section 11).
414
+
415
+However, if you cease all violation of this License, then your
416
+license from a particular copyright holder is reinstated (a)
417
+provisionally, unless and until the copyright holder explicitly and
418
+finally terminates your license, and (b) permanently, if the copyright
419
+holder fails to notify you of the violation by some reasonable means
420
+prior to 60 days after the cessation.
421
+
422
+Moreover, your license from a particular copyright holder is
423
+reinstated permanently if the copyright holder notifies you of the
424
+violation by some reasonable means, this is the first time you have
425
+received notice of violation of this License (for any work) from that
426
+copyright holder, and you cure the violation prior to 30 days after
427
+your receipt of the notice.
428
+
429
+Termination of your rights under this section does not terminate the
430
+licenses of parties who have received copies or rights from you under
431
+this License.  If your rights have been terminated and not permanently
432
+reinstated, you do not qualify to receive new licenses for the same
433
+material under section 10.
434
+
435
+9. Acceptance Not Required for Having Copies.
436
+
437
+You are not required to accept this License in order to receive or
438
+run a copy of the Program.  Ancillary propagation of a covered work
439
+occurring solely as a consequence of using peer-to-peer transmission
440
+to receive a copy likewise does not require acceptance.  However,
441
+nothing other than this License grants you permission to propagate or
442
+modify any covered work.  These actions infringe copyright if you do
443
+not accept this License.  Therefore, by modifying or propagating a
444
+covered work, you indicate your acceptance of this License to do so.
445
+
446
+10. Automatic Licensing of Downstream Recipients.
447
+
448
+Each time you convey a covered work, the recipient automatically
449
+receives a license from the original licensors, to run, modify and
450
+propagate that work, subject to this License.  You are not responsible
451
+for enforcing compliance by third parties with this License.
452
+
453
+An "entity transaction" is a transaction transferring control of an
454
+organization, or substantially all assets of one, or subdividing an
455
+organization, or merging organizations.  If propagation of a covered
456
+work results from an entity transaction, each party to that
457
+transaction who receives a copy of the work also receives whatever
458
+licenses to the work the party's predecessor in interest had or could
459
+give under the previous paragraph, plus a right to possession of the
460
+Corresponding Source of the work from the predecessor in interest, if
461
+the predecessor has it or can get it with reasonable efforts.
462
+
463
+You may not impose any further restrictions on the exercise of the
464
+rights granted or affirmed under this License.  For example, you may
465
+not impose a license fee, royalty, or other charge for exercise of
466
+rights granted under this License, and you may not initiate litigation
467
+(including a cross-claim or counterclaim in a lawsuit) alleging that
468
+any patent claim is infringed by making, using, selling, offering for
469
+sale, or importing the Program or any portion of it.
470
+
471
+11. Patents.
472
+
473
+A "contributor" is a copyright holder who authorizes use under this
474
+License of the Program or a work on which the Program is based.  The
475
+work thus licensed is called the contributor's "contributor version".
476
+
477
+A contributor's "essential patent claims" are all patent claims
478
+owned or controlled by the contributor, whether already acquired or
479
+hereafter acquired, that would be infringed by some manner, permitted
480
+by this License, of making, using, or selling its contributor version,
481
+but do not include claims that would be infringed only as a
482
+consequence of further modification of the contributor version.  For
483
+purposes of this definition, "control" includes the right to grant
484
+patent sublicenses in a manner consistent with the requirements of
485
+this License.
486
+
487
+Each contributor grants you a non-exclusive, worldwide, royalty-free
488
+patent license under the contributor's essential patent claims, to
489
+make, use, sell, offer for sale, import and otherwise run, modify and
490
+propagate the contents of its contributor version.
491
+
492
+In the following three paragraphs, a "patent license" is any express
493
+agreement or commitment, however denominated, not to enforce a patent
494
+(such as an express permission to practice a patent or covenant not to
495
+sue for patent infringement).  To "grant" such a patent license to a
496
+party means to make such an agreement or commitment not to enforce a
497
+patent against the party.
498
+
499
+If you convey a covered work, knowingly relying on a patent license,
500
+and the Corresponding Source of the work is not available for anyone
501
+to copy, free of charge and under the terms of this License, through a
502
+publicly available network server or other readily accessible means,
503
+then you must either (1) cause the Corresponding Source to be so
504
+available, or (2) arrange to deprive yourself of the benefit of the
505
+patent license for this particular work, or (3) arrange, in a manner
506
+consistent with the requirements of this License, to extend the patent
507
+license to downstream recipients.  "Knowingly relying" means you have
508
+actual knowledge that, but for the patent license, your conveying the
509
+covered work in a country, or your recipient's use of the covered work
510
+in a country, would infringe one or more identifiable patents in that
511
+country that you have reason to believe are valid.
512
+
513
+If, pursuant to or in connection with a single transaction or
514
+arrangement, you convey, or propagate by procuring conveyance of, a
515
+covered work, and grant a patent license to some of the parties
516
+receiving the covered work authorizing them to use, propagate, modify
517
+or convey a specific copy of the covered work, then the patent license
518
+you grant is automatically extended to all recipients of the covered
519
+work and works based on it.
520
+
521
+A patent license is "discriminatory" if it does not include within
522
+the scope of its coverage, prohibits the exercise of, or is
523
+conditioned on the non-exercise of one or more of the rights that are
524
+specifically granted under this License.  You may not convey a covered
525
+work if you are a party to an arrangement with a third party that is
526
+in the business of distributing software, under which you make payment
527
+to the third party based on the extent of your activity of conveying
528
+the work, and under which the third party grants, to any of the
529
+parties who would receive the covered work from you, a discriminatory
530
+patent license (a) in connection with copies of the covered work
531
+conveyed by you (or copies made from those copies), or (b) primarily
532
+for and in connection with specific products or compilations that
533
+contain the covered work, unless you entered into that arrangement,
534
+or that patent license was granted, prior to 28 March 2007.
535
+
536
+Nothing in this License shall be construed as excluding or limiting
537
+any implied license or other defenses to infringement that may
538
+otherwise be available to you under applicable patent law.
539
+
540
+12. No Surrender of Others' Freedom.
541
+
542
+If conditions are imposed on you (whether by court order, agreement or
543
+otherwise) that contradict the conditions of this License, they do not
544
+excuse you from the conditions of this License.  If you cannot convey a
545
+covered work so as to satisfy simultaneously your obligations under this
546
+License and any other pertinent obligations, then as a consequence you may
547
+not convey it at all.  For example, if you agree to terms that obligate you
548
+to collect a royalty for further conveying from those to whom you convey
549
+the Program, the only way you could satisfy both those terms and this
550
+License would be to refrain entirely from conveying the Program.
551
+
552
+13. Use with the GNU Affero General Public License.
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 Affero 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 special requirements of the GNU Affero General Public License,
560
+section 13, concerning interaction through a network will apply to the
561
+combination as such.
562
+
563
+14. Revised Versions of this License.
564
+
565
+The Free Software Foundation may publish revised and/or new versions of
566
+the GNU General Public License from time to time.  Such new versions will
567
+be similar in spirit to the present version, but may differ in detail to
568
+address new problems or concerns.
569
+
570
+Each version is given a distinguishing version number.  If the
571
+Program specifies that a certain numbered version of the GNU General
572
+Public License "or any later version" applies to it, you have the
573
+option of following the terms and conditions either of that numbered
574
+version or of any later version published by the Free Software
575
+Foundation.  If the Program does not specify a version number of the
576
+GNU General Public License, you may choose any version ever published
577
+by the Free Software Foundation.
578
+
579
+If the Program specifies that a proxy can decide which future
580
+versions of the GNU General Public License can be used, that proxy's
581
+public statement of acceptance of a version permanently authorizes you
582
+to choose that version for the Program.
583
+
584
+Later license versions may give you additional or different
585
+permissions.  However, no additional obligations are imposed on any
586
+author or copyright holder as a result of your choosing to follow a
587
+later version.
588
+
589
+15. Disclaimer of Warranty.
590
+
591
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599
+
600
+16. Limitation of Liability.
601
+
602
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610
+SUCH DAMAGES.
611
+
612
+17. Interpretation of Sections 15 and 16.
613
+
614
+If the disclaimer of warranty and limitation of liability provided
615
+above cannot be given local legal effect according to their terms,
616
+reviewing courts shall apply local law that most closely approximates
617
+an absolute waiver of all civil liability in connection with the
618
+Program, unless a warranty or assumption of liability accompanies a
619
+copy of the Program in return for a fee.
620
+
621
+ END OF TERMS AND CONDITIONS
622
+
623
+How to Apply These Terms to Your New Programs
624
+
625
+If you develop a new program, and you want it to be of the greatest
626
+possible use to the public, the best way to achieve this is to make it
627
+free software which everyone can redistribute and change under these terms.
628
+
629
+To do so, attach the following notices to the program.  It is safest
630
+to attach them to the start of each source file to most effectively
631
+state the exclusion of warranty; and each file should have at least
632
+the "copyright" line and a pointer to where the full notice is found.
633
+
634
+go-avauth
635
+Copyright (C) 2017 AVENTER UG (haftungsbeschraenkt)
636
+
637
+This program is free software: you can redistribute it and/or modify
638
+it under the terms of the GNU General Public License as published by
639
+the Free Software Foundation, either version 3 of the License, or
640
+(at your option) any later version.
641
+
642
+This program is distributed in the hope that it will be useful,
643
+but WITHOUT ANY WARRANTY; without even the implied warranty of
644
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645
+GNU General Public License for more details.
646
+
647
+You should have received a copy of the GNU General Public License
648
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
649
+
650
+Also add information on how to contact you by electronic and paper mail.
651
+
652
+If the program does terminal interaction, make it output a short
653
+notice like this when it starts in an interactive mode:
654
+
655
+go-avauth
656
+Copyright (C) 2017 AVENTER UG (haftungsbeschraenkt)
657
+This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
658
+This is free software, and you are welcome to redistribute it
659
+under certain conditions; type `show c' for details.
660
+
661
+The hypothetical commands `show w' and `show c' should show the appropriate
662
+parts of the General Public License.  Of course, your program's commands
663
+might be different; for a GUI interface, you would use an "about box".
664
+
665
+You should also get your employer (if you work as a programmer) or school,
666
+if any, to sign a "copyright disclaimer" for the program, if necessary.
667
+For more information on this, and how to apply and follow the GNU GPL, see
668
+<http://www.gnu.org/licenses/>.
669
+
670
+The GNU General Public License does not permit incorporating your program
671
+into proprietary programs.  If your program is a subroutine library, you
672
+may consider it more useful to permit linking proprietary applications with
673
+the library.  If this is what you want to do, use the GNU Lesser General
674
+Public License instead of this License.  But first, please read
675
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

+ 57
- 0
README.MD View File

@@ -0,0 +1,57 @@
1
+
2
+We share all our software under OpenSource License. If you like what we are doing, it would be nice if you donate a small fee. 
3
+
4
+[![Donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/AVENTER/donate)
5
+
6
+Our Kanban Board is [here](https://wekan.aventer.biz/b/XePZjKD4mK3eFY8MS/go-avbot)
7
+
8
+# License
9
+go-neb is under the Apache License. To make it more complicated, our code are under GPL. These are:
10
+- aws (services/aws)
11
+- invoice (services/invoice)
12
+
13
+
14
+# What is go-avbot
15
+
16
+AVBOT is our digital working partner. He is helping is with our daily business. From creating and sending out invoices to install server applikations. AVBOT is based on [go-neb](https://github.com/matrix-org/go-neb), a matrix BOT developed in golang. 
17
+
18
+# Requirements
19
+
20
+```
21
+go get github.com/Sirupsen/logrus 
22
+go get github.com/matrix-org/util
23
+go get github.com/mattn/go-sqlite3
24
+go get github.com/prometheus/client_golang/prometheus
25
+go get github.com/matrix-org/dugong
26
+go get github.com/matrix-org/gomatrix
27
+go get github.com/mattn/go-shellwords
28
+go get gopkg.in/yaml.v2
29
+go get golang.org/x/oauth2
30
+go get github.com/google/go-github/github
31
+go get github.com/sirupsen/logrus
32
+go get gopkg.in/alecthomas/kingpin.v2
33
+go get github.com/russross/blackfriday
34
+go get github.com/aws/aws-sdk-go
35
+```
36
+
37
+# Features
38
+
39
+### AWS
40
+- Start/Stop of AWS instances
41
+- Show AWS List and infos of all AWS instances
42
+
43
+### Github
44
+- Monitor repositories and create webhooks of them
45
+- Create issues to repos
46
+
47
+### Ispconfig
48
+- Create Invoice and send them out
49
+- Show invoices of a user
50
+
51
+There are still a lot of work. Currently our main focus is the AWS support.
52
+
53
+
54
+# API Documentation
55
+
56
+- Matrix API: https://www.matrix.org/docs/spec/r0.0.0/client_server.html
57
+- AWS API: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/setting-up.html

+ 137
- 0
api/api.go View File

@@ -0,0 +1,137 @@
1
+// Package api contains the fundamental data types used by Go-NEB.
2
+//
3
+// Most HTTP API calls and/or config file sections are just ways of representing these
4
+// data types.
5
+//
6
+// See also
7
+//
8
+// Package "api.handlers" for information on the HTTP API calls.
9
+package api
10
+
11
+import (
12
+	"encoding/json"
13
+	"errors"
14
+	"net/url"
15
+)
16
+
17
+// ConfigureAuthRealmRequest is a request to /configureAuthRealm
18
+type ConfigureAuthRealmRequest struct {
19
+	// An arbitrary unique identifier for this auth realm. This can be anything.
20
+	// Using an existing ID will REPLACE the entire existing AuthRealm with the new information.
21
+	ID string
22
+	// The type of auth realm. This determines which code is loaded to execute the
23
+	// auth realm. It must be a known type. E.g. "github".
24
+	Type string
25
+	// AuthRealm specific config information. See the docs for the auth realm you're interested in.
26
+	Config json.RawMessage
27
+}
28
+
29
+// RequestAuthSessionRequest is a request to /requestAuthSession
30
+type RequestAuthSessionRequest struct {
31
+	// The realm ID to request a new auth session on. The realm MUST already exist.
32
+	RealmID string
33
+	// The Matrix user ID requesting the auth session. If the auth is successful,
34
+	// this user ID will be associated with the third-party credentials obtained.
35
+	UserID string
36
+	// AuthRealm specific config information. See the docs for the auth realm you're interested in.
37
+	Config json.RawMessage
38
+}
39
+
40
+// ConfigureServiceRequest is a request to /configureService
41
+type ConfigureServiceRequest struct {
42
+	// An arbitrary unique identifier for this service. This can be anything.
43
+	// Using an existing ID will REPLACE the entire Service with the new information.
44
+	ID string
45
+	// The type of service. This determines which code is loaded to execute the
46
+	// service. It must be a known type, e.g. "github".
47
+	Type string
48
+	// The user ID of the configured client that this service will use to communicate with Matrix.
49
+	// The user MUST already be configured.
50
+	UserID string
51
+	// Service-specific config information. See the docs for the service you're interested in.
52
+	Config json.RawMessage
53
+}
54
+
55
+// A ClientConfig contains the configuration information for a matrix client so that
56
+// Go-NEB can drive it. It forms the HTTP body to /configureClient requests.
57
+type ClientConfig struct {
58
+	// The matrix User ID to connect with. E.g. @alice:matrix.org
59
+	UserID string
60
+	// A URL with the host and port of the matrix server. E.g. https://matrix.org:8448
61
+	HomeserverURL string
62
+	// The matrix access token to authenticate the requests with.
63
+	AccessToken string
64
+	// True to start a sync stream for this user, making this a "syncing client". If false, no
65
+	// /sync goroutine will be created and this client won't listen for new events from Matrix. For services
66
+	// which only SEND events into Matrix, it may be desirable to set Sync to false to reduce the
67
+	// number of goroutines Go-NEB has to maintain. For services which respond to !commands,
68
+	// Sync MUST be set to true in order to receive those commands.
69
+	Sync bool
70
+	// True to automatically join every room this client is invited to.
71
+	// This is desirable for services which have !commands as that means anyone can pull the bot
72
+	// into the room. It is up to the service to decide which, if any, users to respond to however.
73
+	AutoJoinRooms bool
74
+	// The desired display name for this client.
75
+	// This does not automatically set the display name for this client. See /configureClient.
76
+	DisplayName string
77
+}
78
+
79
+// Session contains the complete auth session information for a given user on a given realm.
80
+// They are created for use with ConfigFile.
81
+type Session struct {
82
+	SessionID string
83
+	RealmID   string
84
+	UserID    string
85
+	Config    json.RawMessage
86
+}
87
+
88
+// ConfigFile represents config.sample.yaml
89
+type ConfigFile struct {
90
+	Clients  []ClientConfig
91
+	Realms   []ConfigureAuthRealmRequest
92
+	Services []ConfigureServiceRequest
93
+	Sessions []Session
94
+}
95
+
96
+// Check validates the /configureService request
97
+func (c *ConfigureServiceRequest) Check() error {
98
+	if c.ID == "" || c.Type == "" || c.UserID == "" || c.Config == nil {
99
+		return errors.New(`Must supply an "ID", a "Type", a "UserID" and a "Config"`)
100
+	}
101
+	return nil
102
+}
103
+
104
+// Check validates the /configureAuthRealm request
105
+func (c *ConfigureAuthRealmRequest) Check() error {
106
+	if c.ID == "" || c.Type == "" || c.Config == nil {
107
+		return errors.New(`Must supply a "ID", a "Type" and a "Config"`)
108
+	}
109
+	return nil
110
+}
111
+
112
+// Check validates the session config request
113
+func (c *Session) Check() error {
114
+	if c.SessionID == "" || c.UserID == "" || c.RealmID == "" || c.Config == nil {
115
+		return errors.New(`Must supply a "SessionID", a "RealmID", a "UserID" and a "Config"`)
116
+	}
117
+	return nil
118
+}
119
+
120
+// Check that the client has supplied the correct fields.
121
+func (c *ClientConfig) Check() error {
122
+	if c.UserID == "" || c.HomeserverURL == "" || c.AccessToken == "" {
123
+		return errors.New(`Must supply a "UserID", a "HomeserverURL", and an "AccessToken"`)
124
+	}
125
+	if _, err := url.Parse(c.HomeserverURL); err != nil {
126
+		return err
127
+	}
128
+	return nil
129
+}
130
+
131
+// Check that the request is valid.
132
+func (r *RequestAuthSessionRequest) Check() error {
133
+	if r.UserID == "" || r.RealmID == "" || r.Config == nil {
134
+		return errors.New(`Must supply a "UserID", a "RealmID" and a "Config"`)
135
+	}
136
+	return nil
137
+}

+ 311
- 0
api/handlers/auth.go View File

@@ -0,0 +1,311 @@
1
+package handlers
2
+
3
+import (
4
+	"database/sql"
5
+	"encoding/base64"
6
+	"encoding/json"
7
+	"net/http"
8
+	"strings"
9
+
10
+	"../../api"
11
+	"../../database"
12
+	"../../metrics"
13
+	"../../types"
14
+	log "github.com/Sirupsen/logrus"
15
+	"github.com/matrix-org/util"
16
+)
17
+
18
+// RequestAuthSession represents an HTTP handler capable of processing /admin/requestAuthSession requests.
19
+type RequestAuthSession struct {
20
+	Db *database.ServiceDB
21
+}
22
+
23
+// OnIncomingRequest handles POST requests to /admin/requestAuthSession. The HTTP body MUST be
24
+// a JSON object representing type "api.RequestAuthSessionRequest".
25
+//
26
+// This will return HTTP 400 if there are missing fields or the Realm ID is unknown.
27
+// For the format of the response, see the specific AuthRealm that the Realm ID corresponds to.
28
+//
29
+// Request:
30
+//  POST /admin/requestAuthSession
31
+//  {
32
+//      "RealmID": "github_realm_id",
33
+//      "UserID": "@my_user:localhost",
34
+//      "Config": {
35
+//          // AuthRealm specific config info
36
+//      }
37
+//  }
38
+// Response:
39
+//  HTTP/1.1 200 OK
40
+//  {
41
+//      // AuthRealm-specific information
42
+//  }
43
+func (h *RequestAuthSession) OnIncomingRequest(req *http.Request) util.JSONResponse {
44
+	logger := util.GetLogger(req.Context())
45
+	if req.Method != "POST" {
46
+		return util.MessageResponse(405, "Unsupported Method")
47
+	}
48
+	var body api.RequestAuthSessionRequest
49
+	if err := json.NewDecoder(req.Body).Decode(&body); err != nil {
50
+		return util.MessageResponse(400, "Error parsing request JSON")
51
+	}
52
+	logger.WithFields(log.Fields{
53
+		"realm_id": body.RealmID,
54
+		"user_id":  body.UserID,
55
+	}).Print("Incoming auth session request")
56
+
57
+	if err := body.Check(); err != nil {
58
+		logger.WithError(err).Info("Failed Check")
59
+		return util.MessageResponse(400, err.Error())
60
+	}
61
+
62
+	realm, err := h.Db.LoadAuthRealm(body.RealmID)
63
+	if err != nil {
64
+		logger.WithError(err).Info("Failed to LoadAuthRealm")
65
+		return util.MessageResponse(400, "Unknown RealmID")
66
+	}
67
+
68
+	response := realm.RequestAuthSession(body.UserID, body.Config)
69
+	if response == nil {
70
+		logger.WithField("body", body).Error("Failed to RequestAuthSession")
71
+		return util.MessageResponse(500, "Failed to request auth session")
72
+	}
73
+
74
+	metrics.IncrementAuthSession(realm.Type())
75
+
76
+	return util.JSONResponse{
77
+		Code: 200,
78
+		JSON: response,
79
+	}
80
+}
81
+
82
+// RemoveAuthSession represents an HTTP handler capable of processing /admin/removeAuthSession requests.
83
+type RemoveAuthSession struct {
84
+	Db *database.ServiceDB
85
+}
86
+
87
+// OnIncomingRequest handles POST requests to /admin/removeAuthSession.
88
+//
89
+// The JSON object MUST contain the keys "RealmID" and "UserID" to identify the session to remove.
90
+//
91
+// Request
92
+//  POST /admin/removeAuthSession
93
+//  {
94
+//      "RealmID": "github-realm",
95
+//      "UserID": "@my_user:localhost"
96
+//  }
97
+// Response:
98
+//  HTTP/1.1 200 OK
99
+//  {}
100
+func (h *RemoveAuthSession) OnIncomingRequest(req *http.Request) util.JSONResponse {
101
+	logger := util.GetLogger(req.Context())
102
+	if req.Method != "POST" {
103
+		return util.MessageResponse(405, "Unsupported Method")
104
+	}
105
+	var body struct {
106
+		RealmID string
107
+		UserID  string
108
+	}
109
+	if err := json.NewDecoder(req.Body).Decode(&body); err != nil {
110
+		return util.MessageResponse(400, "Error parsing request JSON")
111
+	}
112
+	logger.WithFields(log.Fields{
113
+		"realm_id": body.RealmID,
114
+		"user_id":  body.UserID,
115
+	}).Print("Incoming remove auth session request")
116
+
117
+	if body.UserID == "" || body.RealmID == "" {
118
+		return util.MessageResponse(400, `Must supply a "UserID", a "RealmID"`)
119
+	}
120
+
121
+	_, err := h.Db.LoadAuthRealm(body.RealmID)
122
+	if err != nil {
123
+		return util.MessageResponse(400, "Unknown RealmID")
124
+	}
125
+
126
+	if err := h.Db.RemoveAuthSession(body.RealmID, body.UserID); err != nil {
127
+		logger.WithError(err).Error("Failed to RemoveAuthSession")
128
+		return util.MessageResponse(500, "Failed to remove auth session")
129
+	}
130
+
131
+	return util.JSONResponse{
132
+		Code: 200,
133
+		JSON: struct{}{},
134
+	}
135
+}
136
+
137
+// RealmRedirect represents an HTTP handler which can process incoming redirects for auth realms.
138
+type RealmRedirect struct {
139
+	Db *database.ServiceDB
140
+}
141
+
142
+// Handle requests for an auth realm.
143
+//
144
+// The last path segment of the URL MUST be the base64 form of the Realm ID. What response
145
+// this returns depends on the specific AuthRealm implementation.
146
+func (rh *RealmRedirect) Handle(w http.ResponseWriter, req *http.Request) {
147
+	segments := strings.Split(req.URL.Path, "/")
148
+	// last path segment is the base64d realm ID which we will pass the incoming request to
149
+	base64realmID := segments[len(segments)-1]
150
+	bytesRealmID, err := base64.RawURLEncoding.DecodeString(base64realmID)
151
+	realmID := string(bytesRealmID)
152
+	if err != nil {
153
+		log.WithError(err).WithField("base64_realm_id", base64realmID).Print(
154
+			"Not a b64 encoded string",
155
+		)
156
+		w.WriteHeader(400)
157
+		return
158
+	}
159
+
160
+	realm, err := rh.Db.LoadAuthRealm(realmID)
161
+	if err != nil {
162
+		log.WithError(err).WithField("realm_id", realmID).Print("Failed to load realm")
163
+		w.WriteHeader(404)
164
+		return
165
+	}
166
+	log.WithFields(log.Fields{
167
+		"realm_id": realmID,
168
+	}).Print("Incoming realm redirect request")
169
+	realm.OnReceiveRedirect(w, req)
170
+}
171
+
172
+// ConfigureAuthRealm represents an HTTP handler capable of processing /admin/configureAuthRealm requests.
173
+type ConfigureAuthRealm struct {
174
+	Db *database.ServiceDB
175
+}
176
+
177
+// OnIncomingRequest handles POST requests to /admin/configureAuthRealm. The JSON object
178
+// provided is of type "api.ConfigureAuthRealmRequest".
179
+//
180
+// Request:
181
+//  POST /admin/configureAuthRealm
182
+//  {
183
+//      "ID": "my-realm-id",
184
+//      "Type": "github",
185
+//      "Config": {
186
+//          // Realm-specific configuration information
187
+//      }
188
+//  }
189
+// Response:
190
+//  HTTP/1.1 200 OK
191
+//  {
192
+//      "ID": "my-realm-id",
193
+//      "Type": "github",
194
+//      "OldConfig": {
195
+//          // Old auth realm config information
196
+//      },
197
+//      "NewConfig": {
198
+//          // New auth realm config information
199
+//      },
200
+//  }
201
+func (h *ConfigureAuthRealm) OnIncomingRequest(req *http.Request) util.JSONResponse {
202
+	logger := util.GetLogger(req.Context())
203
+	if req.Method != "POST" {
204
+		return util.MessageResponse(405, "Unsupported Method")
205
+	}
206
+	var body api.ConfigureAuthRealmRequest
207
+	if err := json.NewDecoder(req.Body).Decode(&body); err != nil {
208
+		return util.MessageResponse(400, "Error parsing request JSON")
209
+	}
210
+
211
+	if err := body.Check(); err != nil {
212
+		return util.MessageResponse(400, err.Error())
213
+	}
214
+
215
+	realm, err := types.CreateAuthRealm(body.ID, body.Type, body.Config)
216
+	if err != nil {
217
+		return util.MessageResponse(400, "Error parsing config JSON")
218
+	}
219
+
220
+	if err = realm.Register(); err != nil {
221
+		return util.MessageResponse(400, "Error registering auth realm")
222
+	}
223
+
224
+	oldRealm, err := h.Db.StoreAuthRealm(realm)
225
+	if err != nil {
226
+		logger.WithError(err).Error("Failed to StoreAuthRealm")
227
+		return util.MessageResponse(500, "Error storing realm")
228
+	}
229
+
230
+	return util.JSONResponse{
231
+		Code: 200,
232
+		JSON: struct {
233
+			ID        string
234
+			Type      string
235
+			OldConfig types.AuthRealm
236
+			NewConfig types.AuthRealm
237
+		}{body.ID, body.Type, oldRealm, realm},
238
+	}
239
+}
240
+
241
+// GetSession represents an HTTP handler capable of processing /admin/getSession requests.
242
+type GetSession struct {
243
+	Db *database.ServiceDB
244
+}
245
+
246
+// OnIncomingRequest handles POST requests to /admin/getSession.
247
+//
248
+// The JSON object provided MUST have a "RealmID" and "UserID" in order to fetch the
249
+// correct AuthSession. If there is no session for this tuple of realm and user ID,
250
+// a 200 OK is still returned with "Authenticated" set to false.
251
+//
252
+// Request:
253
+//  POST /admin/getSession
254
+//  {
255
+//      "RealmID": "my-realm",
256
+//      "UserID": "@my_user:localhost"
257
+//  }
258
+// Response:
259
+//  HTTP/1.1 200 OK
260
+//  {
261
+//      "ID": "session_id",
262
+//      "Authenticated": true,
263
+//      "Info": {
264
+//          // Session-specific config info
265
+//      }
266
+//  }
267
+// Response if session not found:
268
+//  HTTP/1.1 200 OK
269
+//  {
270
+//      "Authenticated": false
271
+//  }
272
+func (h *GetSession) OnIncomingRequest(req *http.Request) util.JSONResponse {
273
+	logger := util.GetLogger(req.Context())
274
+	if req.Method != "POST" {
275
+		return util.MessageResponse(405, "Unsupported Method")
276
+	}
277
+	var body struct {
278
+		RealmID string
279
+		UserID  string
280
+	}
281
+	if err := json.NewDecoder(req.Body).Decode(&body); err != nil {
282
+		return util.MessageResponse(400, "Error parsing request JSON")
283
+	}
284
+
285
+	if body.RealmID == "" || body.UserID == "" {
286
+		return util.MessageResponse(400, `Must supply a "RealmID" and "UserID"`)
287
+	}
288
+
289
+	session, err := h.Db.LoadAuthSessionByUser(body.RealmID, body.UserID)
290
+	if err != nil && err != sql.ErrNoRows {
291
+		logger.WithError(err).WithField("body", body).Error("Failed to LoadAuthSessionByUser")
292
+		return util.MessageResponse(500, `Failed to load session`)
293
+	}
294
+	if err == sql.ErrNoRows {
295
+		return util.JSONResponse{
296
+			Code: 200,
297
+			JSON: struct {
298
+				Authenticated bool
299
+			}{false},
300
+		}
301
+	}
302
+
303
+	return util.JSONResponse{
304
+		Code: 200,
305
+		JSON: struct {
306
+			ID            string
307
+			Authenticated bool
308
+			Info          interface{}
309
+		}{session.ID(), session.Authenticated(), session.Info()},
310
+	}
311
+}

+ 69
- 0
api/handlers/client.go View File

@@ -0,0 +1,69 @@
1
+package handlers
2
+
3
+import (
4
+	"encoding/json"
5
+	"net/http"
6
+
7
+	"../../api"
8
+	"../../clients"
9
+	"github.com/matrix-org/util"
10
+)
11
+
12
+// ConfigureClient represents an HTTP handler capable of processing /admin/configureClient requests.
13
+type ConfigureClient struct {
14
+	Clients *clients.Clients
15
+}
16
+
17
+// OnIncomingRequest handles POST requests to /admin/configureClient. The JSON object provided
18
+// is of type "api.ClientConfig".
19
+//
20
+// If a DisplayName is supplied, this request will set this client's display name
21
+// if the old ClientConfig DisplayName differs from the new ClientConfig DisplayName.
22
+//
23
+// Request:
24
+//  POST /admin/configureClient
25
+//  {
26
+//      "UserID": "@my_bot:localhost",
27
+//      "HomeserverURL": "http://localhost:8008",
28
+//      "Sync": true,
29
+//      "DisplayName": "My Bot"
30
+//  }
31
+//
32
+// Response:
33
+//  HTTP/1.1 200 OK
34
+//  {
35
+//       "OldClient": {
36
+//         // The old api.ClientConfig
37
+//       },
38
+//       "NewClient": {
39
+//         // The new api.ClientConfig
40
+//       }
41
+//  }
42
+func (s *ConfigureClient) OnIncomingRequest(req *http.Request) util.JSONResponse {
43
+	if req.Method != "POST" {
44
+		return util.MessageResponse(405, "Unsupported Method")
45
+	}
46
+
47
+	var body api.ClientConfig
48
+	if err := json.NewDecoder(req.Body).Decode(&body); err != nil {
49
+		return util.MessageResponse(400, "Error parsing request JSON")
50
+	}
51
+
52
+	if err := body.Check(); err != nil {
53
+		return util.MessageResponse(400, "Error parsing client config")
54
+	}
55
+
56
+	oldClient, err := s.Clients.Update(body)
57
+	if err != nil {
58
+		util.GetLogger(req.Context()).WithError(err).WithField("body", body).Error("Failed to Clients.Update")
59
+		return util.MessageResponse(500, "Error storing token")
60
+	}
61
+
62
+	return util.JSONResponse{
63
+		Code: 200,
64
+		JSON: struct {
65
+			OldClient api.ClientConfig
66
+			NewClient api.ClientConfig
67
+		}{oldClient, body},
68
+	}
69
+}

+ 34
- 0
api/handlers/heartbeat.go View File

@@ -0,0 +1,34 @@
1
+// Package handlers contains the HTTP handlers for Go-NEB.
2
+//
3
+// This includes detail on the API paths and top-level JSON keys. For specific service JSON,
4
+// see the service you're interested in.
5
+//
6
+// See also
7
+//
8
+// Package "api" for the format of the JSON request bodies.
9
+package handlers
10
+
11
+import (
12
+	"net/http"
13
+
14
+	"github.com/matrix-org/util"
15
+)
16
+
17
+// Heartbeat implements the heartbeat API
18
+type Heartbeat struct{}
19
+
20
+// OnIncomingRequest returns an empty JSON object which can be used to detect liveness of Go-NEB.
21
+//
22
+// Request:
23
+//  GET /test
24
+//
25
+//
26
+// Response:
27
+//  HTTP/1.1 200 OK
28
+//  {}
29
+func (*Heartbeat) OnIncomingRequest(req *http.Request) util.JSONResponse {
30
+	return util.JSONResponse{
31
+		Code: 200,
32
+		JSON: struct{}{},
33
+	}
34
+}

+ 242
- 0
api/handlers/service.go View File

@@ -0,0 +1,242 @@
1
+package handlers
2
+
3
+import (
4
+	"database/sql"
5
+	"encoding/json"
6
+	"fmt"
7
+	"net/http"
8
+	"sync"
9
+
10
+	"../../api"
11
+	"../../clients"
12
+	"../../database"
13
+	"../../matrix"
14
+	"../../metrics"
15
+	"../../polling"
16
+	"../../types"
17
+	log "github.com/Sirupsen/logrus"
18
+	"github.com/matrix-org/gomatrix"
19
+	"github.com/matrix-org/util"
20
+)
21
+
22
+// ConfigureService represents an HTTP handler which can process /admin/configureService requests.
23
+type ConfigureService struct {
24
+	db               *database.ServiceDB
25
+	clients          *clients.Clients
26
+	mapMutex         sync.Mutex
27
+	mutexByServiceID map[string]*sync.Mutex
28
+}
29
+
30
+// NewConfigureService creates a new ConfigureService handler
31
+func NewConfigureService(db *database.ServiceDB, clients *clients.Clients) *ConfigureService {
32
+	return &ConfigureService{
33
+		db:               db,
34
+		clients:          clients,
35
+		mutexByServiceID: make(map[string]*sync.Mutex),
36
+	}
37
+}
38
+
39
+func (s *ConfigureService) getMutexForServiceID(serviceID string) *sync.Mutex {
40
+	s.mapMutex.Lock()
41
+	defer s.mapMutex.Unlock()
42
+	m := s.mutexByServiceID[serviceID]
43
+	if m == nil {
44
+		// XXX TODO: There's a memory leak here. The amount of mutexes created is unbounded, as there will be 1 per service which are never deleted.
45
+		// A better solution would be to have a striped hash map with a bounded pool of mutexes. We can't live with a single global mutex because the Register()
46
+		// function this is protecting does many many HTTP requests which can take a long time on bad networks and will head of line block other services.
47
+		m = &sync.Mutex{}
48
+		s.mutexByServiceID[serviceID] = m
49
+	}
50
+	return m
51
+}
52
+
53
+// OnIncomingRequest handles POST requests to /admin/configureService.
54
+//
55
+// The request body MUST be of type "api.ConfigureServiceRequest".
56
+//
57
+// Request:
58
+//  POST /admin/configureService
59
+//  {
60
+//      "ID": "my_service_id",
61
+//      "Type": "service-type",
62
+//      "UserID": "@my_bot:localhost",
63
+//      "Config": {
64
+//          // service-specific config information
65
+//      }
66
+//  }
67
+// Response:
68
+//  HTTP/1.1 200 OK
69
+//  {
70
+//      "ID": "my_service_id",
71
+//      "Type": "service-type",
72
+//      "OldConfig": {
73
+//          // old service-specific config information
74
+//      },
75
+//      "NewConfig": {
76
+//          // new service-specific config information
77
+//      },
78
+//  }
79
+func (s *ConfigureService) OnIncomingRequest(req *http.Request) util.JSONResponse {
80
+	if req.Method != "POST" {
81
+		return util.MessageResponse(405, "Unsupported Method")
82
+	}
83
+
84
+	service, httpErr := s.createService(req)
85
+	if httpErr != nil {
86
+		return *httpErr
87
+	}
88
+	logger := util.GetLogger(req.Context())
89
+	logger.WithFields(log.Fields{
90
+		"service_id":      service.ServiceID(),
91
+		"service_type":    service.ServiceType(),
92
+		"service_user_id": service.ServiceUserID(),
93
+	}).Print("Incoming configure service request")
94
+
95
+	// Have mutexes around each service to queue up multiple requests for the same service ID
96
+	mut := s.getMutexForServiceID(service.ServiceID())
97
+	mut.Lock()
98
+	defer mut.Unlock()
99
+
100
+	old, err := s.db.LoadService(service.ServiceID())
101
+	if err != nil && err != sql.ErrNoRows {
102
+		logger.WithError(err).Error("Failed to LoadService")
103
+		return util.MessageResponse(500, "Error loading old service")
104
+	}
105
+
106
+	client, err := s.clients.Client(service.ServiceUserID())
107
+	if err != nil {
108
+		return util.MessageResponse(400, "Unknown matrix client")
109
+	}
110
+
111
+	if err := checkClientForService(service, client); err != nil {
112
+		return util.MessageResponse(400, err.Error())
113
+	}
114
+
115
+	if err = service.Register(old, client); err != nil {
116
+		return util.MessageResponse(500, "Failed to register service: "+err.Error())
117
+	}
118
+
119
+	oldService, err := s.db.StoreService(service)
120
+	if err != nil {
121
+		logger.WithError(err).Error("Failed to StoreService")
122
+		return util.MessageResponse(500, "Error storing service")
123
+	}
124
+
125
+	// Start any polling NOW because they may decide to stop it in PostRegister, and we want to make
126
+	// sure we'll actually stop.
127
+	if _, ok := service.(types.Poller); ok {
128
+		if err := polling.StartPolling(service); err != nil {
129
+			logger.WithFields(log.Fields{
130
+				"service_id": service.ServiceID(),
131
+				log.ErrorKey: err,
132
+			}).Error("Failed to start poll loop.")
133
+		}
134
+	}
135
+
136
+	service.PostRegister(old)
137
+	metrics.IncrementConfigureService(service.ServiceType())
138
+
139
+	return util.JSONResponse{
140
+		Code: 200,
141
+		JSON: struct {
142
+			ID        string
143
+			Type      string
144
+			OldConfig types.Service
145
+			NewConfig types.Service
146
+		}{service.ServiceID(), service.ServiceType(), oldService, service},
147
+	}
148
+}
149
+
150
+func (s *ConfigureService) createService(req *http.Request) (types.Service, *util.JSONResponse) {
151
+	var body api.ConfigureServiceRequest
152
+	if err := json.NewDecoder(req.Body).Decode(&body); err != nil {
153
+		res := util.MessageResponse(400, "Error parsing request JSON")
154
+		return nil, &res
155
+	}
156
+
157
+	if err := body.Check(); err != nil {
158
+		res := util.MessageResponse(400, err.Error())
159
+		return nil, &res
160
+	}
161
+
162
+	service, err := types.CreateService(body.ID, body.Type, body.UserID, body.Config)
163
+	if err != nil {
164
+		res := util.MessageResponse(400, "Error parsing config JSON")
165
+		return nil, &res
166
+	}
167
+	return service, nil
168
+}
169
+
170
+// GetService represents an HTTP handler which can process /admin/getService requests.
171
+type GetService struct {
172
+	Db *database.ServiceDB
173
+}
174
+
175
+// OnIncomingRequest handles POST requests to /admin/getService.
176
+//
177
+// The request body MUST be a JSON body which has an "ID" key which represents
178
+// the service ID to get.
179
+//
180
+// Request:
181
+//  POST /admin/getService
182
+//  {
183
+//      "ID": "my_service_id"
184
+//  }
185
+// Response:
186
+//  HTTP/1.1 200 OK
187
+//  {
188
+//      "ID": "my_service_id",
189
+//      "Type": "github",
190
+//      "Config": {
191
+//          // service-specific config information
192
+//      }
193
+//  }
194
+func (h *GetService) OnIncomingRequest(req *http.Request) util.JSONResponse {
195
+	if req.Method != "POST" {
196
+		return util.MessageResponse(405, "Unsupported Method")
197
+	}
198
+	var body struct {
199
+		ID string
200
+	}
201
+	if err := json.NewDecoder(req.Body).Decode(&body); err != nil {
202
+		return util.MessageResponse(400, "Error parsing request JSON")
203
+	}
204
+
205
+	if body.ID == "" {
206
+		return util.MessageResponse(400, `Must supply a "ID"`)
207
+	}
208
+
209
+	srv, err := h.Db.LoadService(body.ID)
210
+	if err != nil {
211
+		if err == sql.ErrNoRows {
212
+			return util.MessageResponse(404, `Service not found`)
213
+		}
214
+		util.GetLogger(req.Context()).WithError(err).Error("Failed to LoadService")
215
+		return util.MessageResponse(500, `Failed to load service`)
216
+	}
217
+
218
+	return util.JSONResponse{
219
+		Code: 200,
220
+		JSON: struct {
221
+			ID     string
222
+			Type   string
223
+			Config types.Service
224
+		}{srv.ServiceID(), srv.ServiceType(), srv},
225
+	}
226
+}
227
+
228
+func checkClientForService(service types.Service, client *gomatrix.Client) error {
229
+	// If there are any commands or expansions for this Service then the service user ID
230
+	// MUST be a syncing client or else the Service will never get the incoming command/expansion!
231
+	cmds := service.Commands(client)
232
+	expans := service.Expansions(client)
233
+	if len(cmds) > 0 || len(expans) > 0 {
234
+		nebStore := client.Store.(*matrix.NEBStore)
235
+		if !nebStore.ClientConfig.Sync {
236
+			return fmt.Errorf(
237
+				"Service type '%s' requires a syncing client", service.ServiceType(),
238
+			)
239
+		}
240
+	}
241
+	return nil
242
+}

+ 66
- 0
api/handlers/webhook.go View File

@@ -0,0 +1,66 @@
1
+package handlers
2
+
3
+import (
4
+	"encoding/base64"
5
+	"net/http"
6
+	"strings"
7
+
8
+	"../../clients"
9
+	"../../database"
10
+	"../../metrics"
11
+	log "github.com/Sirupsen/logrus"
12
+)
13
+
14
+// Webhook represents an HTTP handler capable of accepting webhook requests on behalf of services.
15
+type Webhook struct {
16
+	db      *database.ServiceDB
17
+	clients *clients.Clients
18
+}
19
+
20
+// NewWebhook returns a new webhook HTTP handler
21
+func NewWebhook(db *database.ServiceDB, cli *clients.Clients) *Webhook {
22
+	return &Webhook{db, cli}
23
+}
24
+
25
+// Handle an incoming webhook HTTP request.
26
+//
27
+// The webhook MUST have a known base64 encoded service ID as the last path segment
28
+// in order for this request to be passed to the correct service, or else this will return
29
+// HTTP 400. If the base64 encoded service ID is unknown, this will return HTTP 404.
30
+// Beyond this, the exact response is determined by the specific Service implementation.
31
+func (wh *Webhook) Handle(w http.ResponseWriter, req *http.Request) {
32
+	log.WithField("path", req.URL.Path).Print("Incoming webhook request")
33
+	segments := strings.Split(req.URL.Path, "/")
34
+	// last path segment is the service ID which we will pass the incoming request to,
35
+	// but we've base64d it.
36
+	base64srvID := segments[len(segments)-1]
37
+	bytesSrvID, err := base64.RawURLEncoding.DecodeString(base64srvID)
38
+	if err != nil {
39
+		log.WithError(err).WithField("base64_service_id", base64srvID).Print(
40
+			"Not a b64 encoded string",
41
+		)
42
+		w.WriteHeader(400)
43
+		return
44
+	}
45
+	srvID := string(bytesSrvID)
46
+
47
+	service, err := wh.db.LoadService(srvID)
48
+	if err != nil {
49
+		log.WithError(err).WithField("service_id", srvID).Print("Failed to load service")
50
+		w.WriteHeader(404)
51
+		return
52
+	}
53
+	cli, err := wh.clients.Client(service.ServiceUserID())
54
+	if err != nil {
55
+		log.WithError(err).WithField("user_id", service.ServiceUserID()).Print(
56
+			"Failed to retrieve matrix client instance")
57
+		w.WriteHeader(500)
58
+		return
59
+	}
60
+	log.WithFields(log.Fields{
61
+		"service_id":   service.ServiceID(),
62
+		"service_type": service.ServiceType(),
63
+	}).Print("Incoming webhook for service")
64
+	metrics.IncrementWebhook(service.ServiceType())
65
+	service.OnReceiveWebhook(w, req, cli)
66
+}

+ 245
- 0
app.go View File

@@ -0,0 +1,245 @@
1
+package main
2
+
3
+import (
4
+	"encoding/json"
5
+	"fmt"
6
+	"io/ioutil"
7
+	"net/http"
8
+	_ "net/http/pprof"
9
+	"path/filepath"
10
+
11
+	"./api"
12
+	"./api/handlers"
13
+	"./clients"
14
+	"./database"
15
+	"./polling"
16
+	_ "./realms/github"
17
+	_ "./services/aws"
18
+	_ "./services/echo"
19
+	_ "./services/github"
20
+	_ "./services/invoice"
21
+	"./types"
22
+	log "github.com/Sirupsen/logrus"
23
+	"github.com/matrix-org/dugong"
24
+	"github.com/matrix-org/util"
25
+	_ "github.com/mattn/go-sqlite3"
26
+	"github.com/prometheus/client_golang/prometheus"
27
+
28
+	yaml "gopkg.in/yaml.v2"
29
+)
30
+
31
+var BIND_ADDRESS string
32
+var DATABASE_TYPE string
33
+var DATABASE_URL string
34
+var BASE_URL string
35
+var CONFIG_FILE string
36
+var LOG_DIR string
37
+
38
+// loadFromConfig loads a config file and returns a ConfigFile
39
+func loadFromConfig(db *database.ServiceDB, configFilePath string) (*api.ConfigFile, error) {
40
+	// ::Horrible hacks ahead::
41
+	// The config is represented as YAML, and we want to convert that into NEB types.
42
+	// However, NEB types make liberal use of json.RawMessage which the YAML parser
43
+	// doesn't like. We can't implement MarshalYAML/UnmarshalYAML as a custom type easily
44
+	// because YAML is insane and supports numbers as keys. The YAML parser therefore has the
45
+	// generic form of map[interface{}]interface{} - but the JSON parser doesn't know
46
+	// how to parse that.
47
+	//
48
+	// The hack that follows gets around this by type asserting all parsed YAML keys as
49
+	// strings then re-encoding/decoding as JSON. That is:
50
+	// YAML bytes -> map[interface]interface -> map[string]interface -> JSON bytes -> NEB types
51
+
52
+	// Convert to YAML bytes
53
+	contents, err := ioutil.ReadFile(configFilePath)
54
+	if err != nil {
55
+		return nil, err
56
+	}
57
+
58
+	// Convert to map[interface]interface
59
+	var cfg map[interface{}]interface{}
60
+	if err = yaml.Unmarshal(contents, &cfg); err != nil {
61
+		return nil, fmt.Errorf("Failed to unmarshal YAML: %s", err)
62
+	}
63
+
64
+	// Convert to map[string]interface
65
+	dict := convertKeysToStrings(cfg)
66
+
67
+	// Convert to JSON bytes
68
+	b, err := json.Marshal(dict)
69
+	if err != nil {
70
+		return nil, fmt.Errorf("Failed to marshal config as JSON: %s", err)
71
+	}
72
+
73
+	// Finally, Convert to NEB types
74
+	var c api.ConfigFile
75
+	if err := json.Unmarshal(b, &c); err != nil {
76
+		return nil, fmt.Errorf("Failed to convert to config file: %s", err)
77
+	}
78
+
79
+	// sanity check (at least 1 client and 1 service)
80
+	if len(c.Clients) == 0 || len(c.Services) == 0 {
81
+		return nil, fmt.Errorf("At least 1 client and 1 service must be specified")
82
+	}
83
+
84
+	return &c, nil
85
+}
86
+
87
+func convertKeysToStrings(iface interface{}) interface{} {
88
+	obj, isObj := iface.(map[interface{}]interface{})
89
+	if isObj {
90
+		strObj := make(map[string]interface{})
91
+		for k, v := range obj {
92
+			strObj[k.(string)] = convertKeysToStrings(v) // handle nested objects
93
+		}
94
+		return strObj
95
+	}
96
+
97
+	arr, isArr := iface.([]interface{})
98
+	if isArr {
99
+		for i := range arr {
100
+			arr[i] = convertKeysToStrings(arr[i]) // handle nested objects
101
+		}
102
+		return arr
103
+	}
104
+	return iface // base type like string or number
105
+}
106
+
107
+func insertServicesFromConfig(clis *clients.Clients, serviceReqs []api.ConfigureServiceRequest) error {
108
+	for i, s := range serviceReqs {
109
+		if err := s.Check(); err != nil {
110
+			return fmt.Errorf("config: Service[%d] : %s", i, err)
111
+		}
112
+		service, err := types.CreateService(s.ID, s.Type, s.UserID, s.Config)
113
+		if err != nil {
114
+			return fmt.Errorf("config: Service[%d] : %s", i, err)
115
+		}
116
+
117
+		// Fetch the client for this service and register/poll
118
+		c, err := clis.Client(s.UserID)
119
+		if err != nil {
120
+			return fmt.Errorf("config: Service[%d] : %s", i, err)
121
+		}
122
+
123
+		if err = service.Register(nil, c); err != nil {
124
+			return fmt.Errorf("config: Service[%d] : %s", i, err)
125
+		}
126
+		if _, err := database.GetServiceDB().StoreService(service); err != nil {
127
+			return fmt.Errorf("config: Service[%d] : %s", i, err)
128
+		}
129
+		service.PostRegister(nil)
130
+	}
131
+	return nil
132
+}
133
+
134
+func loadDatabase(databaseType, databaseURL, configYAML string) (*database.ServiceDB, error) {
135
+	if configYAML != "" {
136
+		databaseType = "sqlite3"
137
+		databaseURL = ":memory:?_busy_timeout=5000"
138
+	}
139
+
140
+	db, err := database.Open(databaseType, databaseURL)
141
+	if err == nil {
142
+		database.SetServiceDB(db) // set singleton
143
+	}
144
+	return db, err
145
+}
146
+
147
+func setup(e envVars, mux *http.ServeMux, matrixClient *http.Client) {
148
+	err := types.BaseURL(e.BaseURL)
149
+	if err != nil {
150
+		log.WithError(err).Panic("Failed to get base url")
151
+	}
152
+
153
+	db, err := loadDatabase(e.DatabaseType, e.DatabaseURL, e.ConfigFile)
154
+	if err != nil {
155
+		log.WithError(err).Panic("Failed to open database")
156
+	}
157
+
158
+	// Populate the database from the config file if one was supplied.
159
+	var cfg *api.ConfigFile
160
+	if e.ConfigFile != "" {
161
+		if cfg, err = loadFromConfig(db, e.ConfigFile); err != nil {
162
+			log.WithError(err).WithField("config_file", e.ConfigFile).Panic("Failed to load config file")
163
+		}
164
+		if err := db.InsertFromConfig(cfg); err != nil {
165
+			log.WithError(err).Panic("Failed to persist config data into in-memory DB")
166
+		}
167
+		log.Info("Inserted ", len(cfg.Clients), " clients")
168
+		log.Info("Inserted ", len(cfg.Realms), " realms")
169
+		log.Info("Inserted ", len(cfg.Sessions), " sessions")
170
+	}
171
+
172
+	clients := clients.New(db, matrixClient)
173
+	if err := clients.Start(); err != nil {
174
+		log.WithError(err).Panic("Failed to start up clients")
175
+	}
176
+
177
+	// Handle non-admin paths for normal NEB functioning
178
+	mux.Handle("/metrics", prometheus.Handler())
179
+	mux.Handle("/test", prometheus.InstrumentHandler("test", util.MakeJSONAPI(&handlers.Heartbeat{})))
180
+	wh := handlers.NewWebhook(db, clients)
181
+	mux.HandleFunc("/services/hooks/", prometheus.InstrumentHandlerFunc("webhookHandler", util.Protect(wh.Handle)))
182
+	rh := &handlers.RealmRedirect{db}
183
+	mux.HandleFunc("/realms/redirects/", prometheus.InstrumentHandlerFunc("realmRedirectHandler", util.Protect(rh.Handle)))
184
+
185
+	// Read exclusively from the config file if one was supplied.
186
+	// Otherwise, add HTTP listeners for new Services/Sessions/Clients/etc.
187
+	if e.ConfigFile != "" {
188
+		if err := insertServicesFromConfig(clients, cfg.Services); err != nil {
189
+			log.WithError(err).Panic("Failed to insert services")
190
+		}
191
+
192
+		log.Info("Inserted ", len(cfg.Services), " services")
193
+	} else {
194
+		mux.Handle("/admin/getService", prometheus.InstrumentHandler("getService", util.MakeJSONAPI(&handlers.GetService{db})))
195
+		mux.Handle("/admin/getSession", prometheus.InstrumentHandler("getSession", util.MakeJSONAPI(&handlers.GetSession{db})))
196
+		mux.Handle("/admin/configureClient", prometheus.InstrumentHandler("configureClient", util.MakeJSONAPI(&handlers.ConfigureClient{clients})))
197
+		mux.Handle("/admin/configureService", prometheus.InstrumentHandler("configureService", util.MakeJSONAPI(handlers.NewConfigureService(db, clients))))
198
+		mux.Handle("/admin/configureAuthRealm", prometheus.InstrumentHandler("configureAuthRealm", util.MakeJSONAPI(&handlers.ConfigureAuthRealm{db})))
199
+		mux.Handle("/admin/requestAuthSession", prometheus.InstrumentHandler("requestAuthSession", util.MakeJSONAPI(&handlers.RequestAuthSession{db})))
200
+		mux.Handle("/admin/removeAuthSession", prometheus.InstrumentHandler("removeAuthSession", util.MakeJSONAPI(&handlers.RemoveAuthSession{db})))
201
+	}
202
+	polling.SetClients(clients)
203
+	if err := polling.Start(); err != nil {
204
+		log.WithError(err).Panic("Failed to start polling")
205
+	}
206
+}
207
+
208
+type envVars struct {
209
+	BindAddress  string
210
+	DatabaseType string
211
+	DatabaseURL  string
212
+	BaseURL      string
213
+	LogDir       string
214
+	ConfigFile   string
215
+}
216
+
217
+func main() {
218
+	e := envVars{
219
+		BindAddress:  BIND_ADDRESS,
220
+		DatabaseType: DATABASE_TYPE,
221
+		DatabaseURL:  DATABASE_URL,
222
+		BaseURL:      BASE_URL,
223
+		LogDir:       LOG_DIR,
224
+		ConfigFile:   CONFIG_FILE,
225
+	}
226
+
227
+	if e.LogDir != "" {
228
+		log.AddHook(dugong.NewFSHook(
229
+			filepath.Join(e.LogDir, "info.log"),
230
+			filepath.Join(e.LogDir, "warn.log"),
231
+			filepath.Join(e.LogDir, "error.log"),
232
+			&log.TextFormatter{
233
+				TimestampFormat:  "2006-01-02 15:04:05.000000",
234
+				DisableColors:    true,
235
+				DisableTimestamp: false,
236
+				DisableSorting:   false,
237
+			}, &dugong.DailyRotationSchedule{GZip: false},
238
+		))
239
+	}
240
+
241
+	log.Infof("GO-AVBOT (%+v)", e)
242
+
243
+	setup(e, http.DefaultServeMux, http.DefaultClient)
244
+	log.Fatal(http.ListenAndServe(e.BindAddress, nil))
245
+}

+ 388
- 0
clients/clients.go View File

@@ -0,0 +1,388 @@
1
+package clients
2
+
3
+import (
4
+	"database/sql"
5
+	"fmt"
6
+	"net/http"
7
+	"strings"
8
+	"sync"
9
+	"time"
10
+
11