diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..dfe0770
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..8fe07f8
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,32 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+yarn.lock
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# secret configuration
+config.json
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e62ec04
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6c9bf48
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# ctcaldap
+ .. is a Church Tools Ldap Proxy and using many ideas and loc from the https://github.com/milux/ctldap.git repository. Goal of the effort was to
+ - refactor code so it is
+ - it is unit testable
+ - it is mockable
+ - offers better adaptability
+ - support migrations from existing IDM (in case of Calvary Chapel Freiburg a pre-existing LDAP providing user authentication and groups to Nextcloud and Big Blue Button) by offering to
+ - filter groups
+ - map groups
+ - fill fields depending on groups
+ - maybe allow different kinds of caching
+
+Like milux/ctladp it is heavily based on ldapjs.
+
+## Installation
+
+Node.js is required to run this software. http://nodejs.org/
+
+Get and install node, clone the repo and run `npm install` (`yarn`) to install dependancies. After that you can run the tests by `npm run test` (`yarn test`) or the cli by `node . `
+
diff --git a/config.example.json b/config.example.json
new file mode 100644
index 0000000..e1aece3
--- /dev/null
+++ b/config.example.json
@@ -0,0 +1,13 @@
+{
+ "name": "sitename",
+ "user": "",
+ "password": "",
+ "url": "https://sitename.church.tools/",
+ "selectionGroupIds": [],
+ "tranformedGroups": [
+ {
+ "gid": 0,
+ "name": "Group Name"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/ctcaldap.config b/ctcaldap.config
new file mode 100644
index 0000000..0d5e987
--- /dev/null
+++ b/ctcaldap.config
@@ -0,0 +1,7 @@
+; logmode 0=none
+loglevel=0
+
+; This is required for clients using lowercase DNs, e.g. ownCloud/nextCloud
+dn_lower_case=true
+; This is required for clients that need lowercase email addresses, e.g. Seafile
+email_lower_case=true
\ No newline at end of file
diff --git a/index.js b/index.js
new file mode 100644
index 0000000..0567358
--- /dev/null
+++ b/index.js
@@ -0,0 +1,79 @@
+var fs = require("fs");
+var ini = require("ini");
+var path = require("path");
+
+exports.config = ini.parse(
+ fs.readFileSync(path.resolve(__dirname, "ctcaldap.config"), "utf-8")
+);
+
+const ldap = require("ldapjs");
+const server = ldap.createServer();
+
+server.search("o=example", (req, res, next) => {
+ const obj = {
+ dn: req.dn.toString(),
+ attributes: {
+ objectclass: ["organization", "top"],
+ o: "example",
+ },
+ };
+});
+
+var rootobj = {
+ dn: "dc=ccfreiburg,dc=de",
+ attributes: {
+ createtimestamp: "20200406114647Z",
+ creatorsname: "cn=admin,dc=ccfreiburg,dc=de",
+ dc: "ccfreiburg",
+ entrycsn: "20200406114647.018289Z#000000#000#000000",
+ entrydn: "dc=ccfreiburg,dc=de",
+ entryuuid: "0a0f7af6-0c48-103a-873b-5963809e173f",
+ hassubordinates: true,
+ modifiersname: "cn=admin,dc=ccfreiburg,dc=de",
+ modifytimestamp: "20200406114647Z",
+ o: "Calvary Chapel Freiburg",
+ objectclass: ["top", "organization"],
+ structuralobjectclass: "organization",
+ subschemasubentry: "cn=Subschema",
+ },
+};
+
+server.search("o=example", (req, res, next) => {
+ const obj = {
+ dn: "o=example",
+ attributes: {
+ objectclass: ["organization", "top", "dcObject"],
+ o: "example",
+ hasSubordinates: true,
+ },
+ };
+ if (req.filter.matches(obj.attributes)) res.send(obj);
+ res.end();
+});
+server.search("oc=top, cn=Subschema", (req, res, next) => {
+ const obj = {
+ dn: "oc=top, cn=Subschema",
+ attributes: {
+ parentTo: "all",
+ },
+ };
+ if (req.filter.matches(obj.attributes)) res.send(obj);
+ res.end();
+});
+
+server.search("", (req, res) => {
+ obj = rootobj;
+ if (req.filter.matches(obj.attributes)) res.send(obj);
+ res.end();
+});
+
+server.listen(1389, () => {
+ console.log("LDAP server listening at %s", server.url);
+});
+
+if (this.config.sites) {
+ Object.keys(this.config.sites).map((sitename) => {
+ var site = config.sites[sitename];
+ console.log(site + " Setting site config");
+ });
+}
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..6c4d07f
--- /dev/null
+++ b/package.json
@@ -0,0 +1,41 @@
+{
+ "name": "ctcaldap",
+ "version": "1.0.0",
+ "description": "ChurchTools LDAP Proxy",
+ "main": "index.js",
+ "scripts": {
+ "test": "mocha ./test/*.test.js",
+ "integration": "mocha ./test/*.integration.js"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/AlexRoehm/ctcaldap.git"
+ },
+ "keywords": [
+ "ChurchTools",
+ "LDAP",
+ "Migration",
+ "NextCloud"
+ ],
+ "author": "Alex Röhm",
+ "license": "GPL-3.0-or-later",
+ "bugs": {
+ "url": "https://github.com/AlexRoehm/ctcaldap/issues"
+ },
+ "homepage": "https://github.com/AlexRoehm/ctcaldap#readme",
+ "devDependencies": {
+ "chai": "^4.3.4",
+ "mocha": "^8.3.2"
+ },
+ "dependencies": {
+ "axios": "^0.21.4",
+ "chai-as-promised": "^7.1.1",
+ "dotenv": "^16.0.2",
+ "extend": "^3.0.2",
+ "ini": "^2.0.0",
+ "ldap-escape": "^2.0.5",
+ "ldapjs": "^2.3.1",
+ "nyc": "^15.1.0",
+ "path": "^0.12.7"
+ }
+}
\ No newline at end of file
diff --git a/src/constants.js b/src/constants.js
new file mode 100644
index 0000000..386c95d
--- /dev/null
+++ b/src/constants.js
@@ -0,0 +1,9 @@
+exports.API_SLUG = "api"
+exports.WHOAMI_AP = "/whoami?only_allow_authenticated=true"
+exports.CSRF_AP = "/csrftoken"
+exports.LOGIN_AP = "/login"
+exports.INFO_AP = "/info"
+exports.GROUPMEMBERS_AP = "/groups/members?with_deleted=false"
+exports.IDS = "&ids[]="
+exports.PERSONS_AP = "/persons"
+exports.LDAPID_FIELD = "ncuid"
diff --git a/src/ctapi.js b/src/ctapi.js
new file mode 100644
index 0000000..4747084
--- /dev/null
+++ b/src/ctapi.js
@@ -0,0 +1,55 @@
+const log = require("./logging");
+const c = require("./constants");
+const extend = require("extend");
+const axios = require("axios").default;
+
+
+exports.ChurchToolsError = (message) => {
+ err = new Error(message)
+ log.error(message);
+ err.name = "ChurchToolsError"
+ return err;
+}
+
+exports.ChurchToolsFatalError = (message) => {
+ err = new Error(message)
+ log.error(message);
+ err.name = "ChurchToolsFatalError"
+ return err;
+}
+
+uriTrailingSlash = (uri) => (uri.slice(-1) !== "/" ? uri + "/" : uri);
+
+
+exports.result = (result, success, failed) => {
+ if (result && result.hasOwnProperty("data")) {
+ if (success) success(result);
+ log.debug(JSON.stringify(result.data));
+ return result.data
+ } else if (result && result.hasOwnProperty("status") && result.status === "success") {
+ if (success) success(result);
+ log.debug(JSON.stringify(result.data));
+ return result.data
+ } else if (result && result.hasOwnProperty("message")) {
+ if (failed) failed();
+ throw this.ChurchToolsError(result.message);
+ } else if (result && result.hasOwnProperty("status") &&
+ [400, 401, 403, 404, 405, 500, 501, 502, 503, 504].includes(result.status)) {
+ if (failed) failed();
+ throw this.ChurchToolsError("No Session or connection problems");
+ } else {
+ log.error(JSON.stringify(result));
+ throw this.ChurchToolsFatalError("Unexpected Error");
+ }
+}
+
+exports.request = async (request, success, failed) => {
+ log.debug(JSON.stringify(request))
+ var result = {}
+ try {
+ result = await axios(request)
+ } catch (err) {
+ throw this.ChurchToolsError(err.message);
+ }
+ return this.result(result, success, failed)
+}
diff --git a/src/ctconnection.js b/src/ctconnection.js
new file mode 100644
index 0000000..3efbe58
--- /dev/null
+++ b/src/ctconnection.js
@@ -0,0 +1,166 @@
+const log = require("./logging");
+const c = require("./constants");
+const ctapi = require("./ctapi");
+const axiosReal = require("axios").default;
+
+
+var connectionPool = {};
+
+exports.getEmptyConnection = (sitename, baseurl) => {
+ var connection = {};
+ connection.name = sitename;
+ connection.baseurl = (baseurl ? baseurl : "");
+ connection.cookie = "";
+ connection.csrfToken = "";
+ connection.loginPromise = null;
+ connection.loginErrorCount = 0;
+ connection.connected = false;
+ return connection;
+};
+
+exports.getConnection = (site) => {
+ if (!connectionPool.hasOwnProperty(site.name)) {
+ connectionPool[site.name] = this.getEmptyConnection(site.name, site.url);
+ }
+ return connectionPool[site.name];
+};
+
+exports.isConnected = (sitename) => {
+ if (!connectionPool.hasOwnProperty(sitename)) {
+ return false;
+ }
+ return connectionPool[sitename].csrfToken.length > 0;
+};
+
+exports.disconnect = (connection) => {
+ connection.csrfToken = ""
+};
+
+/**
+ * Returns a promise for the login on the ChurchTools API.
+ * If a pending login promise already exists, it is returned right away.
+ */
+exports.login = async (site) => {
+
+ var conn = this.getConnection(site);
+ if (conn.loginPromise) return Promise.resolve(conn.loginPromise);
+
+ if (conn.loginErrorCount >= 3)
+ throw ctapi.ChurchToolsFatalError("Too many failed logins in a row");
+
+ var result = {}
+ try {
+ conn.loginPromise = loginPromise(conn, site.user, site.password)
+ result = await conn.loginPromise;
+ } catch (err) {
+ result = err.response
+ }
+ conn.loginPromise = null;
+
+ return ctapi.result(result,
+ () => conn.loginErrorCount = 0,
+ () => conn.loginErrorCount = conn.loginErrorCount + 1)
+};
+
+exports.infoReal = async (baseurl) => {
+ const request = {
+ method: "get",
+ url: baseurl + c.API_SLUG + c.INFO_AP
+ };
+ return await ctapi.request(request)
+};
+
+
+exports.getCsrfTokenReal = async (baseurl, cookie) => {
+ const request = {
+ method: "get",
+ url: baseurl + c.API_SLUG + c.CSRF_AP,
+ headers: {
+ Cookie: cookie,
+ },
+ json: true,
+ }
+ return await ctapi.request(request)
+};
+
+
+getCookie = (result) => {
+ return result.headers["set-cookie"][0];
+};
+
+const loginfunc = async (conn, user, password) => {
+ conn.csrfToken = "";
+ const request = {
+ method: "post",
+ url: conn.baseurl + c.API_SLUG + c.LOGIN_AP,
+ data: {
+ "username": user,
+ "rememberMe": false,
+ "password": password
+ }
+ }
+ const successfunc = (result) => {
+ conn.cookie = getCookie(result);
+ }
+ const { data } = await ctapi.request(request, successfunc)
+ conn.csrfToken = await getCsrfToken(conn.baseurl, conn.cookie);
+ conn.loginPromise = null;
+ log.info(conn.baseurl + " - CT API login completed");
+ return data;
+}
+
+exports.loginPromiseReal = (conn, user, password) => {
+ conn.loginPromise = loginfunc(conn, user, password)
+ return conn.loginPromise;
+};
+
+exports.getPromiseReal = async (url, site) => {
+ const conn = this.getConnection(site);
+ var retryWithAuth = true
+ var result = {}
+ while (retryWithAuth) {
+ retryWithAuth = false
+ try {
+ if (!this.isConnected(site.name)) {
+ log.debug("Try again to log in")
+ await this.login(site)
+ }
+ const reqest = {
+ url: url,
+ headers: {
+ 'Cookie': conn.cookie,
+ 'CSRF-Token': (conn.csrftoken ? conn.csrftoken : "")
+ },
+ json: true,
+ }
+ result = await axios(reqest)
+ return ctapi.result(result)
+ } catch (err) {
+ if (err.name === "ChurchToolsError" || (err.response && err.response.status == 401)) {
+ this.disconnect(conn)
+ retryWithAuth = true;
+ } else
+ throw err
+ }
+ }
+ return result
+}
+
+exports.get = (url, site) => getPromise(url, site);
+
+// Mocks for internal functions
+
+var axios = axiosReal;
+var getPromise = this.getPromiseReal;
+var loginPromise = this.loginPromiseReal;
+var getCsrfToken = this.getCsrfTokenReal;
+exports.setAxiosMock = (mock) => (axios = mock);
+exports.setLoginMock = (login) => (loginPromise = login);
+exports.setGetCsrfTokenMock = (getToken) => (getCsrfToken = getToken);
+exports.setGetMock = (get) => (getPromise = get);
+exports.resetMocks = () => {
+ axios = axiosReal;
+ getPromise = this.getPromiseReal;
+ loginPromise = this.loginPromiseReal;
+ getCsrfToken = this.getCsrfTokenReal;
+}
\ No newline at end of file
diff --git a/src/ctservice.js b/src/ctservice.js
new file mode 100644
index 0000000..7db0d47
--- /dev/null
+++ b/src/ctservice.js
@@ -0,0 +1,45 @@
+const log = require("./logging");
+const c = require("./constants");
+const t = require("./transform");
+const ctconn = require("./ctconnection");
+
+exports.getPersonsInGroups = async (groupIds, site) => {
+ var url = site.url + c.API_SLUG + c.GROUPMEMBERS_AP
+ groupIds.forEach(id => {
+ url = url + c.IDS + id
+ });
+ const result = await ctconn.get(url, site)
+ const personIds = []
+ result.data.forEach((el) => {
+ if (!personIds.includes(el.personId))
+ personIds.push(el.personId)
+ })
+ return personIds
+}
+
+exports.getUid = (data) => {
+ if (data[c.LDAPID_FIELD] && data[c.LDAPID_FIELD].length > 0)
+ return data[c.LDAPID_FIELD];
+ return t.stringConvLowercaseUmlaut(data.firstName + "." + data.lastName)
+}
+
+exports.getPersonRecordForId = async (id, site) => {
+ var url = site.url + c.API_SLUG + c.PERSONS_AP + "/" + id;
+ const { data } = await ctconn.get(url, site)
+ var person = {
+ id: data.id,
+ guid: data.guid,
+ firstName: data.firstName,
+ lastName: data.lastName,
+ nickname: data.nickname,
+ street: data.street,
+ mobile: data.mobile,
+ phonePrivate: data.phonePrivate,
+ zip: data.zip,
+ city: data.city,
+ cmsuserid: (data.cmsUserId ? data.cmsUserId : this.getUid(data)),
+ email: data.email,
+ }
+ person[c.LDAPID_FIELD] = this.getUid(data)
+ return person
+}
\ No newline at end of file
diff --git a/src/ldapcache.js b/src/ldapcache.js
new file mode 100644
index 0000000..c894830
--- /dev/null
+++ b/src/ldapcache.js
@@ -0,0 +1,28 @@
+//site.adminDn = site.fnUserDn({ cn: config.ldap_user });
+//site.CACHE = {};
+
+exports.checkPlainPassword = function (password, siteconfig, callback) {
+ if (siteconfig.loginBlockedDate) {
+ var now = new Date();
+ var checkDate = new Date(
+ siteconfig.loginBlockedDate.getTime() + 1000 * 3600 * 24
+ ); // one day
+ if (now < checkDate) {
+ callback(false);
+ return;
+ } else {
+ siteconfig.loginBlockedDate = null;
+ siteconfig.loginErrorCount = 0;
+ }
+ }
+ var valid = password === siteconfig.ldap_password;
+ if (!valid) {
+ siteconfig.loginErrorCount += 1;
+ if (siteconfig.loginErrorCount > 5) {
+ siteconfig.loginBlockedDate = new Date();
+ }
+ }
+ callback(valid);
+};
+
+exports.checkPassword = () => {};
diff --git a/src/ldapserver.js b/src/ldapserver.js
new file mode 100644
index 0000000..18a5ec4
--- /dev/null
+++ b/src/ldapserver.js
@@ -0,0 +1,92 @@
+
+getLdapServer = (key, crt) => {
+ if (crt && key) {
+ logDebug({ sitenmae: "Server" }, "Starting with ssl");
+ var ldapCert = fs.readFileSync(crt, { encoding: "utf8" });
+ var ldapKey = fs.readFileSync(config.ldap_key_filename, { encoding: "utf8" });
+ return ldap.createServer({ certificate: ldapCert, key: ldapKey });
+ } else {
+ return ldap.createServer();
+ }
+}
+
+setEventListenersForSite = (server, siteconfig) => {
+ // Login bind for user
+ server.bind("ou=" + USERS_KEY + ",o=" + sitename, function (req, _res, next) {
+ req.site = config.sites[sitename];
+ next();
+ }, authenticate, endSuccess);
+
+ // Search implementation for user search
+ server.search("ou=" + USERS_KEY + ",o=" + sitename, function (req, _res, next) {
+ req.site = config.sites[sitename];
+ next();
+ }, searchLogging, authorize, function (req, _res, next) {
+ logDebug({ sitename: sitename }, "Search for users");
+ req.checkAll = req.scope !== "base" && req.dn.rdns.length === 2;
+ return next();
+ }, requestUsers, sendUsers, endSuccess);
+
+ // Search implementation for group search
+ server.search("ou=" + GROUPS_KEY + ",o=" + sitename, function (req, _res, next) {
+ req.site = config.sites[sitename];
+ next();
+ }, searchLogging, authorize, function (req, _res, next) {
+ logDebug({ sitename: sitename }, "Search for groups");
+ req.checkAll = req.scope !== "base" && req.dn.rdns.length === 2;
+ return next();
+ }, requestGroups, sendGroups, endSuccess);
+
+ // Search implementation for user and group search
+ server.search("o=" + sitename, function (req, _res, next) {
+ req.site = config.sites[sitename];
+ next();
+ }, searchLogging, authorize, function (req, _res, next) {
+ logDebug({ sitename: sitename }, "Search for users and groups combined");
+ req.checkAll = req.scope === "sub";
+ return next();
+ }, requestUsers, requestGroups, sendUsers, sendGroups, endSuccess);
+
+ // Search the schema from LDAP Root DSE
+ server.search('cn=schema', function (req, res) {
+ logDebug({ sitename: "?" }, " subschema information");
+ console.log(JSON.stringify(req))
+ var obj = {
+ "dn": "cn=schema",
+ "attributes": {
+ "name": "SubschemaSubentry",
+ "equality": "distinguishedNameMatch",
+ "objectClass": ["top", "subschemaSubentry"],
+ "attributeType": [],
+ }
+ };
+ //if (req.filter.matches(obj.attributes))
+ res.send(obj);
+ res.end();
+ }, endSuccess);
+
+ // Search implementation for basic search for Directory Information Tree and the LDAP Root DSE
+ server.search('', function (req, res) {
+ logDebug({ sitename: req.dn.o }, "empty request, return directory information");
+ var obj = {
+ "dn": "",
+ "attributes": {
+ "objectClass": ["top", "RootDSE"],
+ "subschemaSubentry": ["cn=schema"],
+ //"namingContexts": "o=" + req.dn.o,
+ }
+ };
+ if (req.filter.matches(obj.attributes))
+ res.send(obj);
+ res.end();
+ }, endSuccess);
+}
+
+exports.startLdapServer = (serverconfig, siteconfig) => {
+ var server = getLdapServer(serverconfig.key, serverconfig.crt)
+ setEventListenersForSite(server, siteconfig)
+ server.listen(parseInt(port), ip,
+ () => {
+ console.log('ChurchTools-LDAP-Wrapper listening @ %s', server.url);
+ })
+}
\ No newline at end of file
diff --git a/src/logging.js b/src/logging.js
new file mode 100644
index 0000000..cc1b366
--- /dev/null
+++ b/src/logging.js
@@ -0,0 +1,57 @@
+exports.loglevel = true;
+exports.loglevels = {
+ quiet: 0,
+ error: 1,
+ warn: 2,
+ info: 3,
+ debug: 4
+}
+
+exports.debugSite = (site, msg) => {
+ if (this.loglevel == this.loglevels.debug) {
+ if (site && site.hasOwnProperty("name"))
+ console.log("[DEBUG] " + site.name + " - " + msg);
+ else if (typeof site === "string")
+ console.log("[DEBUG] " + site + " - " + msg);
+ else console.log("[DEBUG] " + JSON.stringify(site) + " - " + msg);
+ }
+};
+
+exports.warnSite = (site, msg) => {
+ if (this.loglevel >= this.loglevels.warn)
+ console.log("[WARN] " + site.sitename + " - " + msg);
+};
+
+exports.errorSite = (site, msg, error) => {
+ if (this.loglevel >= this.loglevels.error) {
+ console.log("[ERROR] " + site.name + " - " + msg);
+ if (error !== undefined) {
+ console.log(error.stack);
+ }
+ }
+};
+
+exports.debug = (msg) => {
+ if (this.loglevel == this.loglevels.debug) {
+ console.log("[DEBUG] - " + msg);
+ }
+};
+
+exports.warn = (msg) => {
+ if (this.loglevel >= this.loglevels.warn)
+ console.log("[WARN] - " + msg);
+};
+
+exports.error = (msg, error) => {
+ if (this.loglevel >= this.loglevels.error) {
+ console.log("[ERROR] - " + msg);
+ if (error !== undefined) {
+ console.log(error.stack);
+ }
+ }
+};
+
+exports.info = (msg) => {
+ if (this.loglevel >= this.loglevels.info)
+ console.log("[INFO] - " + msg);
+};
\ No newline at end of file
diff --git a/src/transform.js b/src/transform.js
new file mode 100644
index 0000000..ddc63a7
--- /dev/null
+++ b/src/transform.js
@@ -0,0 +1,114 @@
+var ldapEsc = require("ldap-escape");
+
+class DataFormatError extends Error {
+ constructor(message) {
+ super(message);
+ this.name = "DataFormatError";
+ }
+}
+
+exports.lowercase = (s) => (typeof s === "string" ? s.toLowerCase() : s);
+
+exports.identity = (s) => s;
+
+exports.getCompatStringFunc = (isLowercase) =>
+ isLowercase ? this.lowercase : this.identity;
+
+exports.uniqueEmails = (users) => {
+ var mails = {};
+ return users.filter((user) => {
+ if (!user.attributes.email) {
+ return false;
+ }
+ var result = !(user.attributes.email in mails);
+ mails[user.attributes.email] = true;
+ return result;
+ });
+};
+
+exports.stringConvLowercaseUmlaut = (str) => {
+ return str
+ .toLowerCase()
+ .replace("ö", "oe")
+ .replace("ä", "ae")
+ .replace("ü", "ue")
+ .replace("ß", "ss");
+}
+
+function groupFilter(v) {
+ return v.id == 30 || v.id == 148;
+}
+
+function objectClassesUsr(defaultObjClassUsr) {
+ return (user, groups) => {
+ if (groups[user.id] && groups[user.id].includes("Next Cloud User"))
+ return [defaultObjClassUsr, "nextCloudUser"];
+ else return [defaultObjClassUsr];
+ };
+}
+
+exports.getSiteTransforms = (siteconfig) => {
+ var sitetransform = {};
+ sitetransform.compat = this.getCompatStringFunc(siteconfig.dn_lower_case);
+ sitetransform.userDn = (cn) =>
+ ldapEsc.dn([
+ "cn=",
+ cn,
+ ",ou=",
+ siteconfig.userskey,
+ ",o=",
+ siteconfig.sitename,
+ ]);
+ sitetransform.groupDn = (cn) =>
+ ldapEsc.dn([
+ "cn=",
+ cn,
+ ",ou=",
+ siteconfig.groupkey,
+ ",o=",
+ siteconfig.sitename,
+ ]);
+ sitetransform.compatEmail = this.getCompatStringFunc(
+ siteconfig.email_lower_case
+ );
+ sitetransform.uniqueEmails = siteconfig.emails_unique
+ ? this.uniqueEmails
+ : this.identity;
+ sitetransform.setObjClassUsr = objectClassesUsr(siteconfig.objclassUsr);
+ return sitetransform;
+};
+
+exports.transformUser = (ctUsr, ctUsrGroups, sitetransform) => {
+ result = {};
+ if (!ctUsr) throw new DataFormatError("Empty user object");
+
+ var cn = ctUsr.cmsuserid;
+ console.log(cn);
+ result = {
+ dn: sitetransform.compat(sitetransform.userDn(cn)),
+ attributes: {
+ cn: cn,
+ id: ctUsr.id,
+ displayname: ctUsr.vorname + " " + ctUsr.name,
+ uid: this.stringConvLowercaseUmlaut(ctUsr.vorname + "." + ctUsr.name),
+ entryUUID: "u" + ctUsr.id,
+ bbbrole: cn === "aröhm" ? "admin" : "user",
+ givenname: ctUsr.vorname,
+ street: ctUsr.strasse,
+ telephoneMobile: ctUsr.telefonhandy,
+ telephoneHome: ctUsr.telefonprivat,
+ postalCode: ctUsr.plz,
+ l: ctUsr.ort,
+ sn: ctUsr.name,
+ email: sitetransform.compatEmail(ctUsr.email),
+ mail: sitetransform.compatEmail(ctUsr.email),
+ objectclass: sitetransform.setObjClassUsr(ctUsr, ctUsrGroups),
+ memberof: (ctUsrGroups[ctUsr.id] || [])
+ .filter(groupFilter)
+ .map(function (cn) {
+ return sitetransform.compat(sitetransform.groupDn({ cn: cn }));
+ }),
+ },
+ };
+ return result;
+};
diff --git a/test/ctconnection.integration.js b/test/ctconnection.integration.js
new file mode 100644
index 0000000..4a40133
--- /dev/null
+++ b/test/ctconnection.integration.js
@@ -0,0 +1,42 @@
+const chai = require("chai");
+const expect = chai.expect;
+var chaiAsPromised = require("chai-as-promised");
+chai.use(chaiAsPromised);
+
+const log = require("../src/logging");
+const ctconn = require("../src/ctconnection");
+ChurchToolsError = ctconn.ChurchToolsError;
+
+const site = require("../config.json")
+
+before(() => log.loglevel = log.loglevels.quiet)
+
+
+describe("Simlpe API call integration works", () => {
+ it("Info: gets info object", async () => {
+ const result = await ctconn.infoReal(site.url)
+ expect(result.shortName).to.equal("CCF")
+ }).timeout(2000);
+
+ it("getCsrfTokenReal: throws exception", async () => {
+ const cookie = "";
+ expect(ctconn.getCsrfTokenReal(site.url, cookie))
+ .to.eventually.rejectedWith(ChurchToolsError)
+ }).timeout(2000);
+
+ it("loginPromise: login without helpfull data throws error", () => {
+ con = ctconn.getEmptyConnection(site.name);
+ con.baseurl = site.url;
+ expect(
+ ctconn.loginPromiseReal(con, "", "", "")
+ ).to.be.eventually.rejectedWith(ChurchToolsError);
+ });
+
+ it("loginPromise: login works with real church tools access", async () => {
+ con = ctconn.getEmptyConnection(site.sitename);
+ con.baseurl = site.url;
+ const result = await ctconn.loginPromiseReal(con, site.user, site.password)
+ expect(result.status).to.be.equal("success");
+ }).timeout(6000);
+
+});
diff --git a/test/ctconnection.test.js b/test/ctconnection.test.js
new file mode 100644
index 0000000..bb3b9bf
--- /dev/null
+++ b/test/ctconnection.test.js
@@ -0,0 +1,144 @@
+const chai = require("chai");
+const expect = chai.expect;
+var chaiAsPromised = require("chai-as-promised");
+chai.use(chaiAsPromised);
+
+const log = require("../src/logging");
+const ctapi = require("../src/ctapi");
+const ctconn = require("../src/ctconnection");
+ChurchToolsError = ctapi.ChurchToolsError;
+ChurchToolsFatalError = ctapi.ChurchToolsFatalError;
+
+const site = {
+ name: "nopf",
+ user: "user",
+ pass: "pass",
+ url: "https://nopf.church.tools/",
+};
+
+before(() => log.loglevel = log.loglevels.quiet)
+
+describe("Church Tools Connection", () => {
+ it("getConnection for new site returns empty connection object", () => {
+ var mysite = { ...site };
+ mysite.name = "asdfgggg";
+ actual = ctconn.getConnection(mysite);
+ expect(actual).to.have.property("loginPromise");
+ expect(actual.loginPromise).to.equal(null)
+ expect(actual.name).to.equal(mysite.name);
+ });
+ it("getConnection returns existing connection object", () => {
+ var mysite = { ...site };
+ mysite.name = "asdfggg";
+ expected = ctconn.getConnection(mysite);
+ actual = ctconn.getConnection(mysite);
+ expect(actual).to.equal(expected);
+ });
+
+ it("getConnection returns new one even if there is an existing connection object", () => {
+ var mysite = { ...site };
+ mysite.name = "asdggg";
+ notexpected = ctconn.getConnection(site);
+ actual = ctconn.getConnection(mysite);
+ expect(actual).to.not.equal(notexpected);
+ });
+
+ it("login failed - throws ChurchToolsError", () => {
+ var mysite = { ...site };
+ mysite.name = "ola";
+ ctconn.setLoginMock((c, b, u, p) => {
+ return new Promise((resolve) => {
+ resolve({ message: "login failed" });
+ })
+ })
+ expect(ctconn.login(mysite)).to.eventually.throw(ChurchToolsError)
+ }).timeout(2000);
+
+ it("login - prevents from too many login attempts", () => {
+ var mysite = { ...site };
+ mysite.name = "ola";
+ ctconn.setLoginMock((c, b, u, p) => {
+ return new Promise((resolve) => {
+ resolve({ message: "login failed" });
+ })
+ })
+ expect(
+ new Promise(async (resolve) => {
+ var i = 0;
+ while (i < 5 && failed) {
+ try {
+ await ctconn.login(mysite)
+ } catch (ChurchToolsError) {
+ }
+ i++;
+ }
+ resolve()
+ }
+ )).to.eventually.throw(ChurchToolsFatalError)
+ }).timeout(2000);
+
+ it("get - logs in, if no session", async () => {
+ const expected = { data: { status: "success", data: { test: "test" } } };
+ const site = ctconn.getEmptyConnection("amprf", "url")
+ var loginCalled = false;
+ ctconn.setLoginMock((c, b, u, p) => {
+ loginCalled = true;
+ return Promise.resolve({ data: {} });
+ })
+ ctconn.setAxiosMock((obj) => {
+ return Promise.resolve(expected)
+ })
+ const actual = await ctconn.get("url", site)
+ expect(loginCalled).to.equal(true)
+ expect(actual).to.equal(expected.data);
+ });
+
+ it("get - trys to log in multiple times", async () => {
+ const expected = { data: { status: "success", data: { test: "test" } } };
+ var newsite = { ...site }
+ newsite.name = "amprf";
+ var loginCalls = 0;
+ var axiosCalled = false;
+ function LoginException() {
+ const err = new Error("Kommst net rein")
+ err.response = { status: 400 }
+ return err
+ }
+ ctconn.setLoginMock((c, b, u, p) => {
+ loginCalls++;
+ if (loginCalls < 3)
+ throw new LoginException();
+ return Promise.resolve({ data: {} })
+ })
+ ctconn.setAxiosMock((obj) => {
+ axiosCalled = true;
+ if (loginCalls < 2)
+ return Promise.resolve(false);
+ return Promise.resolve(expected)
+ })
+ const actual = await ctconn.get("url", newsite)
+ expect(loginCalls).to.equal(3)
+ expect(axiosCalled).to.equal(true)
+ expect(actual).to.equal(expected.data);
+ });
+
+ it("get - trys to log in gives up after n times", async () => {
+ const expected = { data: { status: "success", data: { test: "test" } } };
+ var newsite = { ...site }
+ newsite.name = "amprdff";
+ loginCalls = 0;
+ function LoginException() {
+ const err = new Error("Kommst net rein")
+ err.response = { status: 401 }
+ return err
+ }
+ ctconn.setLoginMock((c, b, u, p) => {
+ loginCalls++
+ throw new LoginException();
+ })
+ ctconn.setAxiosMock((obj) => {
+ return Promise.resolve(false);
+ })
+ expect(ctconn.get("url", newsite)).to.eventually.throw(ChurchToolsFatalError)
+ });
+})
\ No newline at end of file
diff --git a/test/ctservice.integration.js b/test/ctservice.integration.js
new file mode 100644
index 0000000..2a7106b
--- /dev/null
+++ b/test/ctservice.integration.js
@@ -0,0 +1,29 @@
+const ctserv = require("../src/ctservice");
+const chai = require("chai");
+const expect = chai.expect;
+var chaiAsPromised = require("chai-as-promised");
+chai.use(chaiAsPromised);
+
+const log = require("../src/logging");
+before(() => log.loglevel = log.loglevels.quiet)
+
+
+describe("CT API calls from service", () => {
+ const site = require("../config.json");
+ it("Selection Group returns the group info and personIds", async () => {
+ const personIds = await ctserv.getPersonsInGroups(site.selectionGroupIds, site);
+ expect(personIds.length).to.be.above(15)
+ expect(personIds).to.contain(3)
+ expect(personIds).to.contain(3041)
+ })
+ it("getPersonRecordsForId returns the detail info for a personId with ncuid set", async () => {
+ const person = await ctserv.getPersonRecordForId(5, site);
+ expect(person.id).to.be.equal(5)
+ expect(person.ncuid).to.be.equal("alex.roehm")
+ })
+ it("getPersonRecordsForId returns the detail info for a personId with ncuid set", async () => {
+ const person = await ctserv.getPersonRecordForId(3, site);
+ expect(person.id).to.be.equal(3)
+ expect(person.ncuid).to.be.equal("samuel.garrard")
+ })
+})
\ No newline at end of file
diff --git a/test/index.test.js b/test/index.test.js
new file mode 100644
index 0000000..4c7e7e0
--- /dev/null
+++ b/test/index.test.js
@@ -0,0 +1,5 @@
+const chai = require('chai');
+const expect = chai.expect;
+
+describe("Command line Main Test", () => {
+})
\ No newline at end of file
diff --git a/test/ldapcache.test.js b/test/ldapcache.test.js
new file mode 100644
index 0000000..c15c751
--- /dev/null
+++ b/test/ldapcache.test.js
@@ -0,0 +1,9 @@
+const chai = require("chai");
+const expect = chai.expect;
+var chaiAsPromised = require("chai-as-promised");
+chai.use(chaiAsPromised);
+
+const ctapi = require("../src/ldapcache");
+describe("LDAP Cache", () => {
+ it("", () => {});
+});
diff --git a/test/transform.test.js b/test/transform.test.js
new file mode 100644
index 0000000..550e165
--- /dev/null
+++ b/test/transform.test.js
@@ -0,0 +1,48 @@
+const chai = require("chai");
+const expect = chai.expect;
+const transform = require("../src/transform.js");
+//const userMockData = require("./data/getUsersData.json");
+
+DataFormatError = transform.DataFormatError;
+
+const siteconfig = {
+ sitename: "site",
+ userskey: "users",
+ groupkey: "groups",
+ objclassUsr: "CTPerson",
+ dn_lower_case: true, // site.dn_lower_case || ((site.dn_lower_case === undefined) && config.dn_lower_case)
+ email_lower_case: true, // || ((site.email_lower_case === undefined) && config.email_lower_case)
+ emails_unique: false, //|| ((site.emails_unique === undefined) && config.emails_unique)
+};
+var sitetransform;
+before(() => {
+ sitetransform = transform.getSiteTransforms(siteconfig);
+});
+describe("Transorm API results to Ldap", () => {
+ it("getCompatStringFunc true returns lowercase func", () => {
+ expect(transform.getCompatStringFunc(true)).to.be.equal(
+ transform.lowercase
+ );
+ });
+ it("getCompatStringFunc false returns identity func", () => {
+ expect(transform.getCompatStringFunc(false)).to.be.equal(
+ transform.identity
+ );
+ });
+ it("transform from empty json object throws exception", () => {
+ expect(() => transform.transformUser({}, [], {})).to.throw(DataFormatError);
+ });
+ it("transform minmal json object does not throw", () => {
+ actual = transform.transformUser(
+ {
+ id: 1,
+ cmsuserid: "adMin",
+ },
+ [],
+ sitetransform
+ );
+ expect(actual.dn).to.be.equal("cn=admin,ou=users,o=site");
+ expect(actual.attributes.cn).to.be.equal("adMin");
+ expect(actual.attributes.id).to.be.equal(1);
+ });
+});