forked from berhsi/doorstatus
Compare commits
42 commits
Author | SHA1 | Date | |
---|---|---|---|
381bd390df | |||
6bd34360a6 | |||
991eeea9f8 | |||
aed3616cf8 | |||
7dd6dbab12 | |||
ef3981fe66 | |||
+++ | c7bd0eafff | ||
+++ | 9fe94d7e6e | ||
+++ | 0eba169038 | ||
+++ | 666a997a90 | ||
+++ | c7fc0b9eff | ||
+++ | 930ab7eef3 | ||
+++ | edece83dd1 | ||
+++ | c4d02a73c9 | ||
+++ | a93bb9ea0a | ||
8f4f6d82d4 | |||
a1d14235ff | |||
7598b237bf | |||
56742d8707 | |||
b6acaa08a8 | |||
e79258b8be | |||
804e9a10e5 | |||
58d9c327c9 | |||
5f3bb44c7b | |||
9894af021e | |||
berhsi | 0cfdeda45e | ||
d734f86979 | |||
001c7cd568 | |||
28de70e732 | |||
berhsi | 8b2362e3a3 | ||
d959e044fd | |||
868c0bd285 | |||
berhsi | 33cde3e602 | ||
641964b17f | |||
c47afa2942 | |||
d610db0d1f | |||
47e2d63304 | |||
61e3e96e12 | |||
berhsi | 64937e7ea9 | ||
d5e31ca789 | |||
ec3a5daf2b | |||
e5109815e7 |
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
|
@ -0,0 +1,2 @@
|
|||
/documentation/build/
|
||||
/source/arduino/build/
|
661
LICENSE.AGPL
Normal file
661
LICENSE.AGPL
Normal file
|
@ -0,0 +1,661 @@
|
|||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are 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.
|
||||
|
||||
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.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
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 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 work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero 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 Affero 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 Affero 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 Affero 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.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
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 AGPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
146
README.md
Normal file
146
README.md
Normal file
|
@ -0,0 +1,146 @@
|
|||
# KrautStatus
|
||||
|
||||
This repository contains documentation and sources of KrautStatus. KrautStatus
|
||||
is the n-th iteration of a software/hardware project to communicate whether
|
||||
Jena's Krautspace is open or closed.
|
||||
|
||||
KrautStatus consists of three components: an Arduino-sensor-combination at the
|
||||
door, a Python script on a local server, and an API file served on by web
|
||||
server.
|
||||
|
||||
The Arduino provides the current state of the door lock upon request via UDP.
|
||||
The state is determined by a reed sensor in the door lock. In addition, it
|
||||
controls an RGB LED matrix shield that provides a visual indication of the door
|
||||
locks's state in the room.
|
||||
|
||||
The python script polls the broadcast state and pushes changes to Twitter,
|
||||
Mastodon and our API file.
|
||||
|
||||
The API file follows the [Space API](http://spaceapi.net) specification, which
|
||||
includes a field indicating whether the space is open or closed.
|
||||
|
||||
## Arduino
|
||||
|
||||
### Arduino: Hardware
|
||||
|
||||
We measure the door's lock state using a reed switch. The switch is installed at
|
||||
the bottom of hole for the deadbolt and gets triggered by a magnet glued to the
|
||||
tip of the deadbolt.
|
||||
|
||||
The reed switch is connected to pin 0 and ground on an Arduino MKR1000. The
|
||||
software sets up pin 0 (by default) with a pull up resistor. This prevents
|
||||
currents induced into the long wire between switch an Arduino to trigger the pin
|
||||
state.
|
||||
|
||||
A second component connected to the MKR1000 is an Arduino MKR RGB Shield that
|
||||
provides a 7x12 RGB LED matrix. It is used to give visual feedback on the
|
||||
software's current state.
|
||||
|
||||
While trying to connect to the configured WLAN, a vertical yellow line
|
||||
oscillates between both sides of the display. When connecting to the WLAN fails,
|
||||
a red cross is displayed. When the room is open all LEDs are green, and when it
|
||||
is closed all LEDs are turned off (nobody should be there to see it anyway).
|
||||
|
||||
The following images is a schematic showing the connections between the three
|
||||
components mentioned.
|
||||
|
||||
![a schematic of Arduino MKR1000 and all components physically connected to it, as described in the text](documentation/arduino.png)
|
||||
|
||||
The Arduino is powered by a USB charger.
|
||||
|
||||
If you need to change the schematic, adapt `documentation/arduino.tex` and run
|
||||
`make`. This requires the following software and TeX libraries to be installed
|
||||
on your systems:
|
||||
|
||||
- pdflatex
|
||||
- convert from ImageMagick
|
||||
- tikz
|
||||
- circuitikz
|
||||
|
||||
### Arduino: Setup and Configuration
|
||||
|
||||
The sketch for our Arduino is located in `sources/arduino`. Before we flash the
|
||||
Arduino with the sketch, we should adapt `config.h`. We can use either the
|
||||
[Arduino IDE](https://www.arduino.cc/en/software) or the provided Makefile to
|
||||
verify or flash the sketch.
|
||||
|
||||
For the Makefile to work,
|
||||
[Arduino CLI](https://arduino.github.io/arduino-cli/latest/) has to be
|
||||
installed. Use `make` for verification and `make install` to flash the board,
|
||||
which needs to be connected to our PC via USB cable.
|
||||
|
||||
Verifying and flashing the sketch requires the installation of several
|
||||
libraries.
|
||||
|
||||
First we need the core for the family of boards Arduino MKR1000
|
||||
belongs to: Arduino SAMD Boards (or `arduino:samd`). Installation instructions
|
||||
for [Arduino IDE](https://www.arduino.cc/en/guide/cores) and
|
||||
[Arduino CLI](https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_core_install/)
|
||||
can be found in the respective documentation.
|
||||
|
||||
Then we need to make sure the following libraries are installed:
|
||||
|
||||
- ArduinoGraphics
|
||||
- Arduino_MKRRGB
|
||||
- uTimerLib
|
||||
- WiFi101
|
||||
|
||||
Installed instructions for
|
||||
[Arduino IDE](https://www.arduino.cc/en/guide/libraries) and
|
||||
[Arduino CLI](https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_lib_install/)
|
||||
can be found in the respective documentation.
|
||||
|
||||
We assign a fixed IP address in the space's WiFi network to the Arduino's MAC
|
||||
address. The MAC address gets printed to `Serial` on each start up. Once
|
||||
connected to the configured WLAN, the IP address is also printed to `Serial`.
|
||||
(TODO: MENTION WHERE TO FIND DOCUMENTATION FOR OUR DHCPD.)
|
||||
|
||||
### Arduino: UDP API
|
||||
|
||||
Once the Arduino has started successfully, it listens on the configured port
|
||||
(see [sources/arduino/config.h](sources/arduino/config.h) for the default port)
|
||||
for UDP packets and answers each incoming packet with the state of the door. The
|
||||
state is encoded as a one byte integer, where `0` stands for closed and `1`
|
||||
stands for open.
|
||||
|
||||
In `scripts` is the Python 3 script `test_udp_api.py`, which we use to test the
|
||||
UDP API. It takes an IP address and optionally a port, queries the Arduino, and
|
||||
prints out the result.
|
||||
|
||||
## In-Space Service
|
||||
|
||||
## Internet Service
|
||||
|
||||
|
||||
## License
|
||||
|
||||
The authors of the Arduino code license the code under the AGPL 3.0 (see
|
||||
`LICENSE.AGPL`). The respective authors are listed in the preambles of each
|
||||
source file.
|
||||
|
||||
## Dependencies
|
||||
|
||||
The creation of the schematic image depends on the following libraries:
|
||||
|
||||
*TikZ* published by the copyright holders under the GPL 2, the Free
|
||||
Documentation License, and the LaTeX Project Public License 1.3c
|
||||
|
||||
*Circuitikz* published by the copyright holders under the GPL 2 and the LaTeX
|
||||
Project Public License
|
||||
|
||||
The Arduino code depends on the following libraries:
|
||||
|
||||
*Arduino SAMD Boards* published by the copyright holders under the LGPL 2.1 or later.
|
||||
|
||||
*SPI Master Library for Arduino Zero* published by the copyright holders under
|
||||
the LGPL 2.1 or later.
|
||||
|
||||
*ArduinoGraphics* published by the copyright holders under the LGPL 2.1 or
|
||||
later.
|
||||
|
||||
*Arduino_MKRRGB* published by the copyright holders under the LGPL 2.1 or later.
|
||||
|
||||
*uTimerLib* published by the copyright holders under the LGPL 3.
|
||||
|
||||
*WiFi101* published by the copyright holders under the
|
||||
LGPL 2.1 or later.
|
304
apistatusd.py
304
apistatusd.py
|
@ -1,304 +0,0 @@
|
|||
#!/usr/bin/python3
|
||||
|
||||
# file: statusd.py
|
||||
# date: 26.07.2019
|
||||
# email: berhsi@web.de
|
||||
|
||||
# Status server, listening for door status updates. The IPv4 address and port
|
||||
# to listen on are configurable, by default localhost:10001 is used. The
|
||||
# connection is secured by TLS and client side authentication.
|
||||
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import socket
|
||||
import ssl
|
||||
import sys
|
||||
from time import time, sleep
|
||||
import configparser
|
||||
|
||||
|
||||
def certs_readable(config):
|
||||
'''
|
||||
checks at start, if the needed certificates defined (no nullstring) and
|
||||
readable.
|
||||
param 1: dictionary
|
||||
return: boolean
|
||||
'''
|
||||
for i in (config['server']['key'], config['server']['cert'],
|
||||
config['client']['cert']):
|
||||
if i == '' or os.access(i, os.R_OK) is False:
|
||||
logging.error('Cannot read {}'.format(i))
|
||||
return False
|
||||
return True
|
||||
|
||||
|
||||
def print_config(config):
|
||||
'''
|
||||
Logs the config with level debug.
|
||||
'''
|
||||
logging.debug('Using config:')
|
||||
for section in config.sections():
|
||||
logging.debug('Section {}'.format(section))
|
||||
for i in config[section]:
|
||||
logging.debug(' {}: {}'.format(i, config[section][i]))
|
||||
|
||||
|
||||
def print_ciphers(cipherlist):
|
||||
'''
|
||||
Prints the list of allowed ciphers.
|
||||
param1: dictionary
|
||||
return: boolean
|
||||
'''
|
||||
print('Available ciphers')
|
||||
for i in cipherlist:
|
||||
print('\n')
|
||||
for j in i.keys():
|
||||
print('{}: {}'.format(j, i[j]))
|
||||
print('\n')
|
||||
|
||||
|
||||
def display_peercert(cert):
|
||||
'''
|
||||
Displays the values of a given certificate.
|
||||
param1: dictionary
|
||||
return: boolean
|
||||
'''
|
||||
for i in cert.keys():
|
||||
print('{}:'.format(i))
|
||||
if i in ('subject', 'issuer'):
|
||||
for j in cert[i]:
|
||||
print('\t{}'.format(j))
|
||||
else:
|
||||
print('\t{}'.format(cert[i]))
|
||||
|
||||
|
||||
def receive_buffer_is_valid(raw_data):
|
||||
'''
|
||||
Checks validity of the received buffer contents.
|
||||
param 1: byte
|
||||
return: boolean
|
||||
'''
|
||||
if raw_data in (b'\x00', b'\x01'):
|
||||
logging.debug('Argument is valid: {}'.format(raw_data))
|
||||
return True
|
||||
|
||||
logging.debug('Argument is not valid: {}'.format(raw_data))
|
||||
return False
|
||||
|
||||
|
||||
def change_status(raw_data, api):
|
||||
'''
|
||||
Write the new status together with a timestamp into the Space API JSON.
|
||||
param 1: byte
|
||||
param 2: string
|
||||
return: boolean
|
||||
'''
|
||||
|
||||
logging.debug('Change status API')
|
||||
# todo: use walrus operator := when migrating to python >= 3.8
|
||||
data = read_api(api)
|
||||
if data is False:
|
||||
return False
|
||||
|
||||
status, timestamp = set_values(raw_data)
|
||||
if os.access(api, os.W_OK):
|
||||
logging.debug('API file is writable')
|
||||
with open(api, 'w') as api_file:
|
||||
logging.debug('API file open successfull')
|
||||
data["state"]["open"] = status
|
||||
data["state"]["lastchange"] = timestamp
|
||||
try:
|
||||
json.dump(data, api_file, indent=4)
|
||||
except Exception as e:
|
||||
logging.error('Failed to change API file')
|
||||
logging.error('{}'.format(e))
|
||||
logging.debug('API file changed')
|
||||
else:
|
||||
logging.error('API file is not writable. Wrong permissions?')
|
||||
return False
|
||||
logging.info('Status successfull changed to {}'.format(status))
|
||||
return True
|
||||
|
||||
|
||||
def read_api(api):
|
||||
'''
|
||||
Reads the Space API JSON into a dict. Returns the dict on success and
|
||||
False on failure.
|
||||
|
||||
param 1: string
|
||||
return: dict or boolean
|
||||
'''
|
||||
logging.debug('Open API file: {}'.format(api))
|
||||
|
||||
# return early if the API JSON cannot be read
|
||||
if not os.access(api, os.R_OK):
|
||||
logging.error('Failed to read API file')
|
||||
return False
|
||||
|
||||
logging.debug('API is readable')
|
||||
with open(api, 'r') as api_file:
|
||||
logging.debug('API file successfully opened')
|
||||
try:
|
||||
api_json_data = json.load(api_file)
|
||||
logging.debug('API file read successfull')
|
||||
except Exception as e:
|
||||
logging.error('Failed to read API file: {}'.format(e))
|
||||
return False
|
||||
return api_json_data
|
||||
|
||||
|
||||
def set_values(raw_data):
|
||||
'''
|
||||
Create a timestamp, changes the value of the given byte into a string
|
||||
and returns both.
|
||||
param 1: byte
|
||||
return: tuple
|
||||
'''
|
||||
status = "true" if raw_data == b'\x01' else "false"
|
||||
timestamp = str(time()).split('.')[0]
|
||||
|
||||
logging.debug('Set values for timestamp: {} and status: {}'.format(
|
||||
timestamp, status))
|
||||
return (status, timestamp)
|
||||
|
||||
|
||||
def main():
|
||||
'''
|
||||
The main function - open a socket, create a ssl context, load certs and
|
||||
listen for connections. At SSL context we set only one available cipher
|
||||
suite and disable compression.
|
||||
OP_NO_COMPRESSION: prevention against CRIME attack
|
||||
OP_DONT_ISERT_EMPTY_FRAGMENTS: prevention agains CBC 4 attack
|
||||
(cve-2011-3389)
|
||||
'''
|
||||
|
||||
loglevel = logging.WARNING
|
||||
formatstring = '%(asctime)s: %(levelname)s: %(message)s'
|
||||
logging.basicConfig(format=formatstring, level=loglevel)
|
||||
|
||||
default_config = {
|
||||
'general': {
|
||||
'timeout': 3.0,
|
||||
'loglevel': 'warning'
|
||||
},
|
||||
'server': {
|
||||
'host': 'localhost',
|
||||
'port': 10001,
|
||||
'cert': './certs/server.crt',
|
||||
'key': './certs/server.key'
|
||||
},
|
||||
'client': {
|
||||
'cert': './certs/client.crt'
|
||||
},
|
||||
'api': {
|
||||
'api': './api',
|
||||
'template': './api_template'
|
||||
}
|
||||
}
|
||||
configfile = './statusd.conf'
|
||||
config = configparser.ConfigParser()
|
||||
config.read_dict(default_config)
|
||||
if not config.read(configfile):
|
||||
logging.warning('Configuration file %s not found or not readable. Using default values.',
|
||||
configfile)
|
||||
|
||||
logger = logging.getLogger()
|
||||
if not config['general']['loglevel'] in ('critical', 'error', 'warning', 'info', 'debug'):
|
||||
logging.warning('Invalid loglevel %s given. Using default level %s.',
|
||||
config['general']['loglevel'],
|
||||
default_config['general']['loglevel'])
|
||||
config.set('general', 'loglevel', default_config['general']['loglevel'])
|
||||
|
||||
logger.setLevel(config['general']['loglevel'].upper())
|
||||
|
||||
print_config(config)
|
||||
|
||||
# todo: zertifikate sollten nur lesbar sein!
|
||||
if not certs_readable(config):
|
||||
logging.error('Cert check failed\nExit')
|
||||
sys.exit(1)
|
||||
|
||||
context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
|
||||
context.verify_mode = ssl.CERT_REQUIRED
|
||||
context.load_cert_chain(certfile=config['server']['cert'],
|
||||
keyfile=config['server']['key'])
|
||||
context.load_verify_locations(cafile=config['client']['cert'])
|
||||
context.set_ciphers('EECDH+AESGCM') # only ciphers for tls 1.2 and 1.3
|
||||
context.options = ssl.OP_CIPHER_SERVER_PREFERENCE
|
||||
# ensure, compression is disabled (disabled by default anyway at the moment)
|
||||
context.options |= ssl.OP_NO_COMPRESSION
|
||||
logging.debug('SSL context created')
|
||||
# print_ciphers(context.get_ciphers())
|
||||
|
||||
with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as mySocket:
|
||||
logging.debug('Socket created')
|
||||
mySocket.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
|
||||
keep = mySocket.getsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE)
|
||||
logging.debug('Socket keepalive: {}'format(keep))
|
||||
try:
|
||||
mySocket.bind((config['server']['host'], int(config['server']['port'])))
|
||||
mySocket.listen(5)
|
||||
except Exception as e:
|
||||
logging.error('Unable to bind and listen')
|
||||
logging.error('{}'.format(e))
|
||||
sys.exit(1)
|
||||
logging.info('Listening on {} at Port {}'.format(config['server']['host'],
|
||||
config['server']['port']))
|
||||
|
||||
while True:
|
||||
try:
|
||||
fromSocket, fromAddr = mySocket.accept()
|
||||
logging.info('Client connected: {}:{}'.format(fromAddr[0], fromAddr[1]))
|
||||
try:
|
||||
fromSocket.settimeout(float(config['general']['timeout']))
|
||||
logging.debug('Connection timeout set to {}'.format(
|
||||
config['general']['timeout']))
|
||||
except Exception:
|
||||
logging.error('Cannot set timeout to {}'.format(
|
||||
config['general']['timeout']))
|
||||
try:
|
||||
conn = context.wrap_socket(fromSocket, server_side=True)
|
||||
conn.settimeout(float(config['general']['timeout']))
|
||||
except socket.timeout:
|
||||
logging.error('Socket timeout')
|
||||
except Exception as e:
|
||||
logging.error('Connection failed: {}'.format(e))
|
||||
logging.info('Connection established')
|
||||
logging.info('Peer certificate commonName: {}'.format(
|
||||
conn.getpeercert()['subject'][5][0][1]))
|
||||
logging.debug('Peer certificate serialNumber: {}'.format(
|
||||
conn.getpeercert()['serialNumber']))
|
||||
|
||||
raw_data = conn.recv(1)
|
||||
if receive_buffer_is_valid(raw_data) is True:
|
||||
if change_status(raw_data, config['api']['api']) is True:
|
||||
logging.debug('Send {} back'.format(raw_data))
|
||||
conn.send(raw_data)
|
||||
# change_status returns false:
|
||||
else:
|
||||
logging.info('Failed to change status')
|
||||
if conn:
|
||||
conn.send(b'\x03')
|
||||
# receive_handle returns false:
|
||||
else:
|
||||
logging.info('Invalid argument received: {}'.format(raw_data))
|
||||
logging.debug('Send {} back'.format(b'\x03'))
|
||||
if conn:
|
||||
conn.send(b'\x03')
|
||||
sleep(0.1) # protection against dos
|
||||
except KeyboardInterrupt:
|
||||
logging.info('Keyboard interrupt received')
|
||||
sys.exit(1)
|
||||
except Exception as e:
|
||||
logging.error('{}'.format(e))
|
||||
continue
|
||||
finally:
|
||||
if mySocket:
|
||||
logging.info('Shutdown socket')
|
||||
mySocket.shutdown(socket.SHUT_RDWR)
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
33
documentation/Makefile
Normal file
33
documentation/Makefile
Normal file
|
@ -0,0 +1,33 @@
|
|||
# Copyright (c):
|
||||
#
|
||||
# Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
#
|
||||
# This file is part of the KrautStatus' Arduino code.
|
||||
#
|
||||
# The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
# modify it under the terms of the GNU Affero General Public License as
|
||||
# published by the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# The Clean CommonMark library is distributed in the hope that it will be
|
||||
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
|
||||
# General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Affero General Public License along
|
||||
# with the Clean CommonMark library. If not, see
|
||||
# <https://www.gnu.org/licenses/>.
|
||||
|
||||
.PHONY: all clean
|
||||
|
||||
all: arduino.png
|
||||
|
||||
clean:
|
||||
rm --recursive build
|
||||
|
||||
arduino.png: arduino.tex build
|
||||
pdflatex -output-directory build arduino
|
||||
convert -density 300 build/arduino.pdf -trim -colorspace RGB arduino.png
|
||||
|
||||
build:
|
||||
mkdir --parents build
|
BIN
documentation/arduino.png
Normal file
BIN
documentation/arduino.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 16 KiB |
74
documentation/arduino.tex
Normal file
74
documentation/arduino.tex
Normal file
|
@ -0,0 +1,74 @@
|
|||
% Copyright (c):
|
||||
%
|
||||
% Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
%
|
||||
% This file is part of the KrautStatus' Arduino code.
|
||||
%
|
||||
% The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
% modify it under the terms of the GNU Affero General Public License as
|
||||
% published by the Free Software Foundation, either version 3 of the License, or
|
||||
% (at your option) any later version.
|
||||
%
|
||||
% The Clean CommonMark library is distributed in the hope that it will be
|
||||
% useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
|
||||
% General Public License for more details.
|
||||
%
|
||||
% You should have received a copy of the GNU Affero General Public License along
|
||||
% with the Clean CommonMark library. If not, see
|
||||
% <https://www.gnu.org/licenses/>.
|
||||
\documentclass[border=1mm]{standalone}
|
||||
|
||||
\usepackage{tikz}
|
||||
\usetikzlibrary{positioning}
|
||||
\usepackage{circuitikz}
|
||||
|
||||
\begin{document}
|
||||
|
||||
\begin{circuitikz}[
|
||||
chip/.style = {
|
||||
dipchip,
|
||||
hide numbers,
|
||||
no topmark,
|
||||
external pins width=0,
|
||||
num pins=14,
|
||||
}]
|
||||
\ctikzset{multipoles/dipchip/width=1.6}
|
||||
|
||||
% Arduino MKR1000
|
||||
\node [chip] (MKR1000) {};
|
||||
% align=center enables line breaks in node text
|
||||
\node [align=center, rotate=90] at (MKR1000.center){Arduino\\MKR1000};
|
||||
|
||||
\draw (MKR1000.n) -- ++(0,1) node[vcc]{};
|
||||
\draw (MKR1000.s) -- ++(0,-1) node[ground] {};
|
||||
|
||||
\node [right, font=\tiny] at (MKR1000.bpin 4) {0};
|
||||
|
||||
\node [left, font=\tiny] at (MKR1000.bpin 12) {VIN};
|
||||
\node [left, font=\tiny] at (MKR1000.bpin 11) {A3};
|
||||
\node [left, font=\tiny] at (MKR1000.bpin 10) {A4};
|
||||
|
||||
% Arduino MKR RGB Shield
|
||||
\node[chip, right=of MKR1000] (RGB) {};
|
||||
% align=center enables line breaks in node text
|
||||
\node [align=center, rotate=90] at (RGB.center){Arduino\\MKR RGB Shield};
|
||||
|
||||
\draw (RGB.s) -- ++(0, -1) node[ground]{};
|
||||
|
||||
\node [right, font=\tiny] at (RGB.bpin 3) {VIN};
|
||||
\node [right, font=\tiny] at (RGB.bpin 4) {A3};
|
||||
\node [right, font=\tiny] at (RGB.bpin 5) {A4};
|
||||
|
||||
\draw (MKR1000.bpin 12) -- (RGB.bpin 3);
|
||||
\draw (MKR1000.bpin 11) -- (RGB.bpin 4);
|
||||
\draw (MKR1000.bpin 10) -- (RGB.bpin 5);
|
||||
|
||||
% Reed switch
|
||||
\draw (MKR1000.bpin 4) -- ++(-1, 0) to [normal open switch, name=R] ++(0, -2.96) node[ground]{};
|
||||
|
||||
\node [rotate=90, above] at (R) {Reed Switch};
|
||||
\end{circuitikz}
|
||||
|
||||
|
||||
\end{document}
|
81
scripts/test_udp_api.py
Executable file
81
scripts/test_udp_api.py
Executable file
|
@ -0,0 +1,81 @@
|
|||
#!/usr/bin/env python3
|
||||
# Copyright (c):
|
||||
#
|
||||
# Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
#
|
||||
# This file is part of the KrautStatus' Arduino code.
|
||||
#
|
||||
# The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
# modify it under the terms of the GNU Affero General Public License as
|
||||
# published by the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# The Clean CommonMark library is distributed in the hope that it will be
|
||||
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
|
||||
# General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Affero General Public License along
|
||||
# with the Clean CommonMark library. If not, see
|
||||
# <https://www.gnu.org/licenses/>.
|
||||
"""
|
||||
Test KrautStatus's UDP API for a given IP and (optionally) port.
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import ipaddress
|
||||
import socket
|
||||
|
||||
def port(string):
|
||||
"Convert string to an unsigend integer that is a valid port number"
|
||||
port = int(string)
|
||||
|
||||
if port < 0 or port > 65535:
|
||||
raise ValueError()
|
||||
|
||||
return port
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(__doc__)
|
||||
|
||||
parser.add_argument("ip",
|
||||
metavar="IP",
|
||||
type=ipaddress.ip_address,
|
||||
help="IP address of the KrautStatus Arduino")
|
||||
|
||||
parser.add_argument("port",
|
||||
nargs="?",
|
||||
metavar="PORT",
|
||||
default=12345,
|
||||
type=port,
|
||||
help="port that the KrautStatus Arduino listens to")
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
|
||||
receiver = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
|
||||
receiver.bind(('0.0.0.0', args.port))
|
||||
print(f'Listening on 0.0.0.0:{args.port}.')
|
||||
|
||||
sender = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
|
||||
# We do not use \0 or \1 here, so that we do not trigger ourselves when
|
||||
# testing the script locally (127.0.0.1)
|
||||
sender.sendto(b'\2', (str(args.ip), args.port))
|
||||
print(f'Sent null byte to {args.ip}:{args.port}.')
|
||||
|
||||
while True:
|
||||
status, address = receiver.recvfrom(1)
|
||||
|
||||
if not address[0] == str(args.ip):
|
||||
continue
|
||||
|
||||
if status[0] == 0:
|
||||
print('Responded: door closed')
|
||||
return
|
||||
|
||||
if status[0] == 1:
|
||||
print('Resondend: door open')
|
||||
return
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
33
source/arduino/Makefile
Normal file
33
source/arduino/Makefile
Normal file
|
@ -0,0 +1,33 @@
|
|||
# Copyright (c):
|
||||
#
|
||||
# Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
#
|
||||
# This file is part of the KrautStatus' Arduino code.
|
||||
#
|
||||
# The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
# modify it under the terms of the GNU Affero General Public License as
|
||||
# published by the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# The Clean CommonMark library is distributed in the hope that it will be
|
||||
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
|
||||
# General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU Affero General Public License along
|
||||
# with the Clean CommonMark library. If not, see
|
||||
# <https://www.gnu.org/licenses/>.
|
||||
|
||||
.PHONY: all clean install
|
||||
|
||||
all:
|
||||
arduino-cli compile --fqbn arduino:samd:mkr1000
|
||||
|
||||
clean:
|
||||
rm --recursive build
|
||||
|
||||
install:
|
||||
PORT=$(arduino-cli board list | \
|
||||
grep arduino:samd:mkr1000 | \
|
||||
sed -e 's/ .*//g'); \
|
||||
arduino-cli upload --fqbn arduino:samd:mkr1000 --port $$PORT
|
70
source/arduino/arduino.ino
Normal file
70
source/arduino/arduino.ino
Normal file
|
@ -0,0 +1,70 @@
|
|||
/*
|
||||
Copyright (c):
|
||||
|
||||
Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
|
||||
This file is part of the KrautStatus' Arduino code.
|
||||
|
||||
The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
modify it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or (at your
|
||||
option) any later version.
|
||||
|
||||
The Clean CommonMark library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along
|
||||
with the Clean CommonMark library. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <SPI.h>
|
||||
#include <uTimerLib.h>
|
||||
|
||||
#include "config.h"
|
||||
#include "matrix.h"
|
||||
#include "sensor.h"
|
||||
#include "serial.h"
|
||||
#include "wifi.h"
|
||||
|
||||
const unsigned long int MATRIX_UPDATE_FREQUENCY = 1;
|
||||
|
||||
void setup() {
|
||||
serial_setup();
|
||||
matrix_setup();
|
||||
|
||||
boolean wifi_result = matrix_show_scan_and_run(wifi_setup);
|
||||
if (!wifi_result) {
|
||||
matrix_show_failure();
|
||||
while(true);
|
||||
}
|
||||
|
||||
sensor_setup();
|
||||
|
||||
start_matrix_update();
|
||||
}
|
||||
|
||||
void loop() {
|
||||
int packetSize = Udp.parsePacket();
|
||||
if (packetSize) {
|
||||
Udp.beginPacket(Udp.remoteIP(), Udp.remotePort());
|
||||
Udp.write(uint8_t(sensor_get_door_state()));
|
||||
Udp.endPacket();
|
||||
}
|
||||
}
|
||||
|
||||
void start_matrix_update() {
|
||||
TimerLib.setInterval_us(matrix_update, 1000000 / MATRIX_UPDATE_FREQUENCY);
|
||||
}
|
||||
|
||||
void matrix_update() {
|
||||
switch (sensor_get_door_state()) {
|
||||
OPEN:
|
||||
matrix_fill(GREEN);
|
||||
break;
|
||||
CLOSED:
|
||||
matrix_fill(BLACK);
|
||||
break;
|
||||
}
|
||||
}
|
33
source/arduino/config.h
Normal file
33
source/arduino/config.h
Normal file
|
@ -0,0 +1,33 @@
|
|||
/*
|
||||
Copyright (c):
|
||||
|
||||
Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
|
||||
This file is part of the KrautStatus' Arduino code.
|
||||
|
||||
The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
modify it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or (at your
|
||||
option) any later version.
|
||||
|
||||
The Clean CommonMark library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along
|
||||
with the Clean CommonMark library. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
// SSID and password of the WiFi network to which we broadcast the door lock's
|
||||
// status.
|
||||
const char SSID[] = "";
|
||||
const char PASSWORD[] = "";
|
||||
|
||||
// Port on which to listen for status requests
|
||||
const unsigned int SERVER_PORT = 12345;
|
||||
|
||||
// Pin to which the reed switch is connected
|
||||
const uint8_t SENSOR_PIN = 0;
|
87
source/arduino/matrix.cpp
Normal file
87
source/arduino/matrix.cpp
Normal file
|
@ -0,0 +1,87 @@
|
|||
/*
|
||||
Copyright (c):
|
||||
|
||||
Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
|
||||
This file is part of the KrautStatus' Arduino code.
|
||||
|
||||
The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
modify it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or (at your
|
||||
option) any later version.
|
||||
|
||||
The Clean CommonMark library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along
|
||||
with the Clean CommonMark library. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <ArduinoGraphics.h>
|
||||
#include <Arduino_MKRRGB.h>
|
||||
#include <uTimerLib.h>
|
||||
|
||||
#include "matrix.h"
|
||||
|
||||
|
||||
const uint32_t RED = COLOR(255, 0, 0);
|
||||
const uint32_t YELLOW = COLOR(255, 255, 0);
|
||||
|
||||
const unsigned long int SCAN_UPDATE_FREQUENCY = 25;
|
||||
|
||||
void matrix_setup() {
|
||||
MATRIX.begin();
|
||||
}
|
||||
|
||||
void matrix_show_failure() {
|
||||
MATRIX.stroke(RED);
|
||||
MATRIX.beginDraw();
|
||||
MATRIX.clear();
|
||||
MATRIX.line(0, 0, MATRIX.width() - 1, MATRIX.height() - 1);
|
||||
MATRIX.line(0, MATRIX.height() - 1, MATRIX.width() - 1, 0);
|
||||
MATRIX.endDraw();
|
||||
}
|
||||
|
||||
uint8_t scan_timer = 0;
|
||||
|
||||
void matrix_paint_scan() {
|
||||
// We paint a vertical line that oscillates between the left and right border
|
||||
// of the matrix. Going back and forth one pixel at a time gives us as period
|
||||
// of
|
||||
// 2 * width - 2
|
||||
// because we do not want to remain at the borders for one tick.
|
||||
scan_timer += 1;
|
||||
scan_timer %= 2 * MATRIX.width() - 2;
|
||||
|
||||
uint8_t position = scan_timer;
|
||||
if(position >= MATRIX.width())
|
||||
position = 2 * MATRIX.width() - position - 2;
|
||||
|
||||
MATRIX.beginDraw();
|
||||
MATRIX.clear();
|
||||
MATRIX.line(position, 0, position, 6);
|
||||
MATRIX.endDraw();
|
||||
}
|
||||
|
||||
bool matrix_show_scan_and_run(bool(*thunk)()) {
|
||||
MATRIX.stroke(YELLOW);
|
||||
TimerLib.setInterval_us(matrix_paint_scan, 1000000 / SCAN_UPDATE_FREQUENCY);
|
||||
|
||||
bool result = thunk();
|
||||
|
||||
TimerLib.clearTimer();
|
||||
MATRIX.beginDraw();
|
||||
MATRIX.clear();
|
||||
MATRIX.endDraw();
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
void matrix_fill(uint32_t color) {
|
||||
MATRIX.fill(color);
|
||||
MATRIX.beginDraw();
|
||||
MATRIX.clear();
|
||||
MATRIX.endDraw();
|
||||
}
|
33
source/arduino/matrix.h
Normal file
33
source/arduino/matrix.h
Normal file
|
@ -0,0 +1,33 @@
|
|||
/*
|
||||
Copyright (c):
|
||||
|
||||
Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
|
||||
This file is part of the KrautStatus' Arduino code.
|
||||
|
||||
The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
modify it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or (at your
|
||||
option) any later version.
|
||||
|
||||
The Clean CommonMark library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along
|
||||
with the Clean CommonMark library. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#define COLOR(r, g, b) (r << 16 | g << 8 | b)
|
||||
|
||||
const uint32_t BLACK = COLOR( 0, 0, 0);
|
||||
const uint32_t GREEN = COLOR( 0, 255, 0);
|
||||
|
||||
void matrix_setup();
|
||||
|
||||
void matrix_show_failure();
|
||||
|
||||
bool matrix_show_scan_and_run(bool(*)());
|
||||
|
||||
void matrix_fill(uint32_t color);
|
35
source/arduino/sensor.cpp
Normal file
35
source/arduino/sensor.cpp
Normal file
|
@ -0,0 +1,35 @@
|
|||
/*
|
||||
Copyright (c):
|
||||
|
||||
Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
|
||||
This file is part of the KrautStatus' Arduino code.
|
||||
|
||||
The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
modify it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or (at your
|
||||
option) any later version.
|
||||
|
||||
The Clean CommonMark library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along
|
||||
with the Clean CommonMark library. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <Arduino.h>
|
||||
|
||||
#include "sensor.h"
|
||||
#include "config.h"
|
||||
|
||||
void sensor_setup() {
|
||||
pinMode(SENSOR_PIN, INPUT_PULLUP);
|
||||
}
|
||||
|
||||
door_state sensor_get_door_state() {
|
||||
if (digitalRead(SENSOR_PIN) == HIGH)
|
||||
return OPEN;
|
||||
return CLOSED;
|
||||
}
|
29
source/arduino/sensor.h
Normal file
29
source/arduino/sensor.h
Normal file
|
@ -0,0 +1,29 @@
|
|||
/*
|
||||
Copyright (c):
|
||||
|
||||
Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
|
||||
This file is part of the KrautStatus' Arduino code.
|
||||
|
||||
The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
modify it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or (at your
|
||||
option) any later version.
|
||||
|
||||
The Clean CommonMark library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along
|
||||
with the Clean CommonMark library. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
typedef enum {
|
||||
CLOSED = 0,
|
||||
OPEN = 1
|
||||
} door_state;
|
||||
|
||||
void sensor_setup();
|
||||
|
||||
door_state sensor_get_door_state();
|
26
source/arduino/serial.cpp
Normal file
26
source/arduino/serial.cpp
Normal file
|
@ -0,0 +1,26 @@
|
|||
/*
|
||||
Copyright (c):
|
||||
|
||||
Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
|
||||
This file is part of the KrautStatus' Arduino code.
|
||||
|
||||
The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
modify it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or (at your
|
||||
option) any later version.
|
||||
|
||||
The Clean CommonMark library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along
|
||||
with the Clean CommonMark library. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <SPI.h>
|
||||
|
||||
void serial_setup() {
|
||||
Serial.begin(9600);
|
||||
}
|
22
source/arduino/serial.h
Normal file
22
source/arduino/serial.h
Normal file
|
@ -0,0 +1,22 @@
|
|||
/*
|
||||
Copyright (c):
|
||||
|
||||
Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
|
||||
This file is part of the KrautStatus' Arduino code.
|
||||
|
||||
The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
modify it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or (at your
|
||||
option) any later version.
|
||||
|
||||
The Clean CommonMark library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along
|
||||
with the Clean CommonMark library. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
void serial_setup();
|
67
source/arduino/wifi.cpp
Normal file
67
source/arduino/wifi.cpp
Normal file
|
@ -0,0 +1,67 @@
|
|||
/*
|
||||
Copyright (c):
|
||||
|
||||
Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
|
||||
This file is part of the KrautStatus' Arduino code.
|
||||
|
||||
The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
modify it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or (at your
|
||||
option) any later version.
|
||||
|
||||
The Clean CommonMark library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along
|
||||
with the Clean CommonMark library. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <SPI.h>
|
||||
#include <WiFi101.h>
|
||||
#include <WiFiUdp.h>
|
||||
|
||||
#include "config.h"
|
||||
|
||||
WiFiUDP Udp;
|
||||
|
||||
void print_mac_address() {
|
||||
uint8_t mac[6];
|
||||
WiFi.macAddress(mac);
|
||||
Serial.print("MAC: ");
|
||||
for(unsigned int i = 5; i > 0; --i) {
|
||||
Serial.print(mac[i], HEX);
|
||||
Serial.print(":");
|
||||
}
|
||||
Serial.println(mac[0], HEX);
|
||||
}
|
||||
|
||||
boolean wifi_setup() {
|
||||
if (WiFi.status() == WL_NO_SHIELD) {
|
||||
Serial.println("No WiFI shield present");
|
||||
return false;
|
||||
}
|
||||
|
||||
print_mac_address();
|
||||
|
||||
while (true) {
|
||||
Serial.print("Connecting to SSID: ");
|
||||
Serial.println(SSID);
|
||||
|
||||
if (WiFi.begin(SSID, PASSWORD) == WL_CONNECTED) {
|
||||
break;
|
||||
}
|
||||
|
||||
delay(10000);
|
||||
}
|
||||
|
||||
Serial.println("Connect to WiFi");
|
||||
Serial.print("IP Address: ");
|
||||
Serial.println(WiFi.localIP());
|
||||
|
||||
Udp.begin(SERVER_PORT);
|
||||
|
||||
return true;
|
||||
}
|
27
source/arduino/wifi.h
Normal file
27
source/arduino/wifi.h
Normal file
|
@ -0,0 +1,27 @@
|
|||
/*
|
||||
Copyright (c):
|
||||
|
||||
Philipp Matthias Schäfer (philipp.matthias.schaefer@posteo.de), 2020
|
||||
|
||||
This file is part of the KrautStatus' Arduino code.
|
||||
|
||||
The Clean CommonMark library is free software: you can redistribute it and/or
|
||||
modify it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or (at your
|
||||
option) any later version.
|
||||
|
||||
The Clean CommonMark library is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
|
||||
for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along
|
||||
with the Clean CommonMark library. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include <WiFi101.h>
|
||||
#include <WiFiUdp.h>
|
||||
|
||||
extern WiFiUDP Udp;
|
||||
|
||||
bool wifi_setup();
|
36
source/nodemcu/statusclient/certs.template
Normal file
36
source/nodemcu/statusclient/certs.template
Normal file
|
@ -0,0 +1,36 @@
|
|||
/*
|
||||
* file: certs.template
|
||||
* desc: This file is part of the Krautspace Doorstatus project. It contains
|
||||
* certificates for the statusclient.ino programm, that runs on a NodeMCU
|
||||
* with a ESP8266 chip.
|
||||
*
|
||||
* Replace the comments in certificate sections with our own certificates.
|
||||
*/
|
||||
|
||||
|
||||
const char SERVER_CERT[] PROGMEM = R"EOF(
|
||||
-----BEGIN CERTIFICATE-----
|
||||
/*
|
||||
* lace for the public server certificate to authenticate the doorstatus
|
||||
* server.
|
||||
*/
|
||||
-----END CERTIFICATE-----
|
||||
)EOF";
|
||||
|
||||
const char CLIENT_CERT[] PROGMEM = R"EOF(
|
||||
-----BEGIN CERTIFICATE-----
|
||||
/*
|
||||
* Place for the clients (this program) public certificate to authenticate
|
||||
* client against the server.
|
||||
*/
|
||||
-----END CERTIFICATE-----
|
||||
)EOF";
|
||||
|
||||
const char CLIENT_KEY[] PROGMEM = R"EOF(
|
||||
-----BEGIN CERTIFICATE-----
|
||||
/*
|
||||
* Place for the clients private key file.
|
||||
*/
|
||||
-----END CERTIFICATE-----
|
||||
)EOF";
|
||||
|
18
source/nodemcu/statusclient/config.h
Normal file
18
source/nodemcu/statusclient/config.h
Normal file
|
@ -0,0 +1,18 @@
|
|||
/*
|
||||
* file: config.h
|
||||
*/
|
||||
|
||||
/* endpoint */
|
||||
#define SERVER_URL "status.kraut.space"
|
||||
#define SERVER_PORT 10001
|
||||
|
||||
/* serial interface settings */
|
||||
#define BAUD_RATE 115200
|
||||
#define DEBUG true
|
||||
|
||||
/* frequence to read the pin */
|
||||
#define FREQUENCY 5000
|
||||
|
||||
/* time server settings */
|
||||
#define NTP_URL "pool.ntp.org"
|
||||
#define TZ_STRING "CET-1CDT,M3.5.0,M10.5.0/3"
|
17
source/nodemcu/statusclient/credentials.template
Normal file
17
source/nodemcu/statusclient/credentials.template
Normal file
|
@ -0,0 +1,17 @@
|
|||
/*
|
||||
* file: credentials.template
|
||||
* desc: This file is part of the Krautspace Doorstatus project. It contains
|
||||
* wifi ssid and passwords for the statusclient.ino programm, that runs on a
|
||||
* NodeMCU with a ESP8266 chip.
|
||||
*
|
||||
* Rename this file into 'credentials.h' and adapt the values to your
|
||||
* wifi conditions.
|
||||
*/
|
||||
|
||||
/* wifi credentials */
|
||||
#define SSID_1 "your_first__wlan_ssid"
|
||||
#define PSK_1 "your_first_wlan_passwort"
|
||||
#define SSID_2 "your_second_wlan_ssid"
|
||||
#define PSK_2 "your_seconde_wlan_password"
|
||||
#define SSID_3 "your_third_wlan_ssid"
|
||||
#define PSK_3 "your_third_wlan_password"
|
260
source/nodemcu/statusclient/statusclient.ino
Normal file
260
source/nodemcu/statusclient/statusclient.ino
Normal file
|
@ -0,0 +1,260 @@
|
|||
/*
|
||||
* file: statusclient.ino
|
||||
* desc: This file is part of the Krautspace Doorstatus project. It's the
|
||||
* main file for a client, who deals with the input from a reed sensor and
|
||||
* push these values to a server. The code is make to run on a NodeMCU with
|
||||
* ESP8266 chip.
|
||||
*/
|
||||
|
||||
#include <ESP8266WiFiMulti.h>
|
||||
#include <WiFiClientSecure.h>
|
||||
#include <time.h>
|
||||
|
||||
#include "config.h"
|
||||
#include "certs.h"
|
||||
#include "credentials.h"
|
||||
|
||||
const int LED_PIN = 16; // D0
|
||||
const int REED_PIN = 5; // D1
|
||||
|
||||
typedef enum {
|
||||
DOOR_CLOSED = 0,
|
||||
DOOR_OPEN = 1
|
||||
} door_state;
|
||||
door_state current_door_state = DOOR_CLOSED;
|
||||
|
||||
BearSSL::WiFiClientSecure client;
|
||||
|
||||
void init_serial() {
|
||||
/*
|
||||
* set baudrate and debug modus
|
||||
*/
|
||||
Serial.begin(BAUD_RATE);
|
||||
Serial.setDebugOutput(DEBUG);
|
||||
Serial.println();
|
||||
Serial.println("[Srl] Serial interface initialized");
|
||||
}
|
||||
|
||||
void init_pins() {
|
||||
/*
|
||||
* set gpio for reed sensor and led
|
||||
*/
|
||||
pinMode(REED_PIN, INPUT_PULLUP);
|
||||
pinMode(LED_PIN, OUTPUT);
|
||||
digitalWrite(LED_PIN, HIGH);
|
||||
Serial.println("[Pin] LED and REED initialized");
|
||||
}
|
||||
|
||||
void init_wifi() {
|
||||
/*
|
||||
* Creates the ssl context. Turns wifi off and than into
|
||||
* access point mode.
|
||||
* TODO: is 'turn of' needed!
|
||||
*/
|
||||
ESP8266WiFiMulti wifi;
|
||||
WiFi.mode(WIFI_OFF);
|
||||
WiFi.mode(WIFI_STA);
|
||||
wifi.addAP(SSID_1, PSK_1);
|
||||
wifi.addAP(SSID_2, NULL);
|
||||
Serial.println("[Wifi] Wifi initialized");
|
||||
wifi.run();
|
||||
if (WiFi.status() == WL_CONNECTED) {
|
||||
Serial.print("[Wif] Connected to ");
|
||||
Serial.println(WiFi.SSID());
|
||||
Serial.print("[Wifi] IP: ");
|
||||
Serial.println(WiFi.localIP());
|
||||
set_clock();
|
||||
} else {
|
||||
Serial.println("[Wifi] Error: Failed to connect");
|
||||
signal_wifi_failed();
|
||||
}
|
||||
}
|
||||
|
||||
door_state read_door_state() {
|
||||
/*
|
||||
* die initialisierung des reed-pin mit pullup bewirkt, daß am pin
|
||||
* 3,3 volt anliegen. die verbindung des pins mit GND sorgt dafür,
|
||||
* daß die spannung "abfließen" kann. dadurch hat der pin dann den
|
||||
* status 'low'.
|
||||
* geschlossene tür -> reed geschlossen -> low
|
||||
* geöffnete tür -> reed offen -> high
|
||||
*/
|
||||
if (digitalRead(REED_PIN) == HIGH) {
|
||||
return DOOR_OPEN;
|
||||
}
|
||||
return DOOR_CLOSED;
|
||||
}
|
||||
|
||||
void signal_door_changed() {
|
||||
/*
|
||||
* LED signal, if door is opened
|
||||
*/
|
||||
uint8_t count = 2;
|
||||
for(uint8_t i=0; i!= count; ++i) {
|
||||
digitalWrite(LED_PIN, LOW);
|
||||
delay(100);
|
||||
digitalWrite(LED_PIN, HIGH);
|
||||
delay(100);
|
||||
}
|
||||
}
|
||||
|
||||
void signal_send_successful() {
|
||||
/*
|
||||
* LED signal, if new status was send successful
|
||||
*/
|
||||
uint8_t count = 5;
|
||||
for(uint8_t i=0; i!= count; ++i) {
|
||||
digitalWrite(LED_PIN, LOW);
|
||||
delay(100);
|
||||
digitalWrite(LED_PIN, HIGH);
|
||||
delay(100);
|
||||
}
|
||||
}
|
||||
|
||||
void signal_clock_failed() {
|
||||
/*
|
||||
* LED signal, if time setting failed
|
||||
*/
|
||||
uint8_t count = 2;
|
||||
for(uint8_t i=0; i!= count; ++i) {
|
||||
digitalWrite(LED_PIN, LOW);
|
||||
delay(500);
|
||||
digitalWrite(LED_PIN, HIGH);
|
||||
delay(500);
|
||||
}
|
||||
delay(2000);
|
||||
}
|
||||
|
||||
void signal_wifi_failed() {
|
||||
/*
|
||||
* LED signal, if wifi initialication was failed
|
||||
*/
|
||||
uint8_t count = 3;
|
||||
for(uint8_t i=0; i!= count; ++i) {
|
||||
digitalWrite(LED_PIN, LOW);
|
||||
delay(500);
|
||||
digitalWrite(LED_PIN, HIGH);
|
||||
delay(500);
|
||||
}
|
||||
delay(2000);
|
||||
}
|
||||
|
||||
void signal_connect_failed() {
|
||||
/*
|
||||
* LED signal, if door is opened
|
||||
*/
|
||||
uint8_t count = 4;
|
||||
for(uint8_t i=0; i!= count; ++i) {
|
||||
digitalWrite(LED_PIN, LOW);
|
||||
delay(500);
|
||||
digitalWrite(LED_PIN, HIGH);
|
||||
delay(500);
|
||||
}
|
||||
delay(2000);
|
||||
}
|
||||
|
||||
void signal_send_failed() {
|
||||
/*
|
||||
* LED signal, if door is opened
|
||||
*/
|
||||
uint8_t count = 5;
|
||||
for(uint8_t i=0; i!= count; ++i) {
|
||||
digitalWrite(LED_PIN, LOW);
|
||||
delay(500);
|
||||
digitalWrite(LED_PIN, HIGH);
|
||||
delay(500);
|
||||
}
|
||||
delay(2000);
|
||||
}
|
||||
|
||||
void set_clock() {
|
||||
/*
|
||||
* We need time for certificate authorization
|
||||
*/
|
||||
configTime(TZ_STRING, NTP_URL);
|
||||
|
||||
Serial.print("[Clock] Waiting for NTP time sync");
|
||||
time_t now = time(nullptr);
|
||||
while (now < 8 * 3600 * 2) {
|
||||
delay(500);
|
||||
Serial.print(".");
|
||||
now = time(nullptr);
|
||||
}
|
||||
Serial.println("");
|
||||
struct tm timeinfo;
|
||||
gmtime_r(&now, &timeinfo);
|
||||
Serial.print("[Clock] Current time: ");
|
||||
Serial.println(asctime(&timeinfo));
|
||||
}
|
||||
|
||||
int send_status(door_state state) {
|
||||
|
||||
/*
|
||||
* Inits wifi (if needed) and send the status
|
||||
*/
|
||||
char status[2] = "";
|
||||
|
||||
if (state == DOOR_CLOSED) {
|
||||
strncpy(status, "0", 1);
|
||||
} else if (state == DOOR_OPEN) {
|
||||
strncpy(status, "1", 1);
|
||||
} else {
|
||||
return 1;
|
||||
}
|
||||
|
||||
BearSSL::X509List server_cert(SERVER_CERT);
|
||||
BearSSL::X509List client_cert(CLIENT_CERT);
|
||||
BearSSL::PrivateKey client_key(CLIENT_KEY);
|
||||
client.setTrustAnchors(&server_cert);
|
||||
client.setClientRSACert(&client_cert, &client_key);
|
||||
Serial.println("[Ctx] SSL Context initialized");
|
||||
Serial.printf("[Send] Connect to %s:%i\n", SERVER_URL, SERVER_PORT);
|
||||
client.connect(SERVER_URL, SERVER_PORT);
|
||||
if (!client.connected()) {
|
||||
Serial.println("[Send] Can't connect to server");
|
||||
Serial.print("[Send] SSL Error: ");
|
||||
Serial.println(client.getLastSSLError());
|
||||
signal_send_failed();
|
||||
client.stop();
|
||||
return 1;
|
||||
} else {
|
||||
ESP.resetFreeContStack();
|
||||
uint32_t freeStackStart = ESP.getFreeContStack();
|
||||
Serial.println("[Send] Connection successful established");
|
||||
Serial.printf("[Send] Send status: %s\n", status);
|
||||
client.write(status);
|
||||
signal_send_successful();
|
||||
client.stop();
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
void setup() {
|
||||
|
||||
/*
|
||||
* things to do once at boot time
|
||||
*/
|
||||
init_serial();
|
||||
init_pins();
|
||||
init_wifi();
|
||||
}
|
||||
|
||||
void loop() {
|
||||
|
||||
/*
|
||||
* things are running in a endless loop
|
||||
*/
|
||||
if (WiFi.status() != WL_CONNECTED) {
|
||||
init_wifi();
|
||||
}
|
||||
door_state new_door_state = read_door_state();
|
||||
if (new_door_state != current_door_state) {
|
||||
Serial.printf("[Loop] Status has changed to %i\n", new_door_state);
|
||||
signal_door_changed();
|
||||
if (send_status(new_door_state) == 0) {
|
||||
current_door_state = new_door_state;
|
||||
}
|
||||
}
|
||||
delay(FREQUENCY);
|
||||
}
|
|
@ -14,12 +14,20 @@ loglevel = debug
|
|||
[server]
|
||||
host = localhost
|
||||
port = 10001
|
||||
cert = ./certs/server-pub.pem
|
||||
key = ./certs/server-key.pem
|
||||
cert = ./certs/statusd-pub.pem
|
||||
key = ./certs/statusd-key.pem
|
||||
|
||||
[client]
|
||||
cert = ./certs/client-pub.pem
|
||||
cert = ./certs/statusclient-pub.pem
|
||||
# possible values: true, false, may
|
||||
required = true
|
||||
|
||||
[api]
|
||||
api = ./api
|
||||
template = ./api_template
|
||||
|
||||
[mastodon]
|
||||
send = false
|
||||
host = localhost
|
||||
token = aaaaa-bbbbb-ccccc-ddddd-eeeee
|
||||
|
426
source/server/apistatusd.py
Executable file
426
source/server/apistatusd.py
Executable file
|
@ -0,0 +1,426 @@
|
|||
#!/usr/bin/python3
|
||||
|
||||
# file: apistatusd.py
|
||||
# date: 26.07.2019
|
||||
# mail: berhsi@web.de
|
||||
|
||||
# Status server, listening for door status updates. The IPv4 address and port
|
||||
# to listen on are configurable, by default localhost:10001 is used. The
|
||||
# connection is secured by TLS and client side authentication.
|
||||
|
||||
try:
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import socket
|
||||
import ssl
|
||||
import sys
|
||||
import requests
|
||||
import threading
|
||||
from time import time, localtime, strftime, sleep
|
||||
import configparser
|
||||
except ImportException as e:
|
||||
print('Import error: {}'.format(e))
|
||||
|
||||
|
||||
def certs_readable(config):
|
||||
'''
|
||||
checks at start, if the needed certificates defined (no nullstring) and
|
||||
readable.
|
||||
param 1: dictionary
|
||||
return: boolean
|
||||
'''
|
||||
for i in (config['server']['key'], config['server']['cert'],
|
||||
config['client']['cert']):
|
||||
if i == '' or os.access(i, os.R_OK) is False:
|
||||
logging.error('Cannot read {}'.format(i))
|
||||
return False
|
||||
return True
|
||||
|
||||
def print_config(config):
|
||||
'''
|
||||
Logs the config with level debug.
|
||||
'''
|
||||
logging.debug('Using config:')
|
||||
for section in config.sections():
|
||||
logging.debug('Section {}'.format(section))
|
||||
for i in config[section]:
|
||||
if i == 'token':
|
||||
logging.debug(' {}: {}'.format(i, 'aaaaa-bbbbb-ccccc-ddddd-eeeee'))
|
||||
else:
|
||||
logging.debug(' {}: {}'.format(i, config[section][i]))
|
||||
|
||||
def create_ssl_context(config):
|
||||
'''
|
||||
Creates the ssl context.
|
||||
return: context object or None
|
||||
'''
|
||||
context = None
|
||||
requirement = None
|
||||
required = config['client']['required'].lower()
|
||||
if required == 'false':
|
||||
requirement = ssl.CERT_NONE
|
||||
elif required == 'may':
|
||||
requirement = ssl.CERT_OPTIONAL
|
||||
else: requirement = ssl.CERT_REQUIRED
|
||||
try:
|
||||
context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
|
||||
context.verify_mode = requirement
|
||||
context.load_cert_chain(certfile=config['server']['cert'],
|
||||
keyfile=config['server']['key'])
|
||||
context.load_verify_locations(cafile=config['client']['cert'])
|
||||
# ensure, compression is disabled (disabled by default anyway at the moment)
|
||||
context.options |= ssl.OP_NO_COMPRESSION
|
||||
context.options = ssl.PROTOCOL_TLS_SERVER
|
||||
context.options = ssl.OP_CIPHER_SERVER_PREFERENCE
|
||||
logging.debug('SSL context created')
|
||||
except Exception as e:
|
||||
logging.error('Failed to create SSL context')
|
||||
logging.error('Error: {}'.format(e))
|
||||
return None
|
||||
return context
|
||||
|
||||
def print_ciphers(cipherlist):
|
||||
'''
|
||||
Prints the list of allowed ciphers.
|
||||
param1: dictionary
|
||||
return: boolean
|
||||
'''
|
||||
logging.debug('Available ciphers')
|
||||
for i in cipherlist:
|
||||
for j in i.keys():
|
||||
if j in ('name', 'protocol'):
|
||||
logging.debug('{}: {}'.format(j, i[j]))
|
||||
|
||||
def print_context(ctx):
|
||||
'''
|
||||
Prints the ssl settings for the given ssl context.
|
||||
param1: context object
|
||||
'''
|
||||
logging.debug('----------- context ----------------')
|
||||
logging.debug('Minimum version ssl: {}'.format(ctx.minimum_version))
|
||||
logging.debug('Maximum version ssl: {}'.format(ctx.maximum_version))
|
||||
logging.debug('SSL options enabled: {}'.format(ctx.options))
|
||||
logging.debug('Protocol: {}'.format(ctx.protocol))
|
||||
logging.debug('Verify flags certificates: {}'.format(ctx.verify_flags))
|
||||
logging.debug('Verify mode: {}'.format(ctx.verify_mode))
|
||||
print_ciphers(ctx.get_ciphers())
|
||||
logging.debug('------------------------------------')
|
||||
|
||||
def display_peercert(cert):
|
||||
'''
|
||||
Displays the values of a given certificate.
|
||||
param1: dictionary or none
|
||||
'''
|
||||
if cert == None:
|
||||
logging.debug('Peer does not offer a certificate')
|
||||
elif len(cert) == 0:
|
||||
logging.debug('Peer certificate was not valid')
|
||||
else:
|
||||
logging.debug('Peer certificate commonName: {}'.format(
|
||||
cert['subject'][5][0][1]))
|
||||
logging.debug('Peer certificate serialNumber: {}'.format(
|
||||
cert['serialNumber']))
|
||||
logging.debug('Peer certificate notBefore: {}'.format(
|
||||
cert['notBefore']))
|
||||
logging.debug('Peer certificate notAfter: {}'.format(
|
||||
cert['notAfter']))
|
||||
|
||||
def receive_buffer_is_valid(raw_data):
|
||||
'''
|
||||
Checks validity of the received buffer contents.
|
||||
param 1: byte object
|
||||
return: boolean
|
||||
'''
|
||||
if raw_data.decode('utf-8', 'strict') in ('0', '1'):
|
||||
logging.debug('Argument is valid: {}'.format(raw_data))
|
||||
return True
|
||||
logging.debug('Argument is not valid: {}'.format(raw_data))
|
||||
return False
|
||||
|
||||
def read_api(api):
|
||||
'''
|
||||
Reads the Space API JSON into a dict. Returns the dict on success and
|
||||
False on failure.
|
||||
|
||||
param 1: string
|
||||
return: dict or boolean
|
||||
'''
|
||||
logging.debug('Open API file: {}'.format(api))
|
||||
# return early if the API JSON cannot be read
|
||||
if not os.access(api, os.R_OK):
|
||||
logging.error('Failed to read API file')
|
||||
return False
|
||||
|
||||
logging.debug('API is readable')
|
||||
with open(api, 'r') as api_file:
|
||||
logging.debug('API file successfully readable opened')
|
||||
try:
|
||||
api_json_data = json.load(api_file)
|
||||
logging.debug('API file successfully read')
|
||||
except Exception as e:
|
||||
logging.error('Failed to read API file: {}'.format(e))
|
||||
return False
|
||||
return api_json_data
|
||||
|
||||
def change_status(status, timestamp, filename):
|
||||
'''
|
||||
Write the new status together with a timestamp into the Space API JSON.
|
||||
param 1: byte object
|
||||
param 2: string
|
||||
return: boolean
|
||||
'''
|
||||
logging.debug('Change status API')
|
||||
# todo: use walrus operator := when migrating to python >= 3.8
|
||||
data = read_api(filename)
|
||||
if data is False:
|
||||
return False
|
||||
|
||||
if os.access(filename, os.W_OK):
|
||||
logging.debug('API file is writable')
|
||||
with open(filename, 'w') as api_file:
|
||||
logging.debug('API file successfull writable opened')
|
||||
data["state"]["open"] = status
|
||||
data["state"]["lastchange"] = timestamp
|
||||
try:
|
||||
json.dump(data, api_file, indent=4)
|
||||
except Exception as e:
|
||||
logging.error('Failed to change API file')
|
||||
logging.error('{}'.format(e))
|
||||
return False
|
||||
logging.debug('API file changed')
|
||||
else:
|
||||
logging.error('API file is not writable. Wrong permissions?')
|
||||
return False
|
||||
logging.info('API file successfull changed to {}'.format(status))
|
||||
return True
|
||||
|
||||
def get_status_and_time(raw_data):
|
||||
'''
|
||||
Create a timestamp, changes the value of the given byte into a string
|
||||
and returns both.
|
||||
param 1: byte object
|
||||
return: tuple (boolean, integer)
|
||||
'''
|
||||
status = True if raw_data.decode('utf-8', 'strict') == '1' else False
|
||||
timestamp = int(str(time()).split('.')[0])
|
||||
|
||||
logging.debug('Set values for timestamp: {} and status: {}'.format(
|
||||
str(timestamp), str(status)))
|
||||
return (status, timestamp)
|
||||
|
||||
def join_path(host, api):
|
||||
'''
|
||||
Becomes two parts (host and api) of the mastodon url and concanate them
|
||||
param1: string
|
||||
param2: string
|
||||
return: string
|
||||
'''
|
||||
url = ''
|
||||
try:
|
||||
if host[-1] == '/' and api[0] == '/':
|
||||
url = ''.join((host, api[1:]))
|
||||
elif host[-1] != '/' and api[0] != '/':
|
||||
url = '/'.join((host, api))
|
||||
else:
|
||||
url = ''.join((host, api))
|
||||
except TypeError as e:
|
||||
logging.error('Can´t join path: {}'.format(e))
|
||||
return url
|
||||
|
||||
class Toot(threading.Thread):
|
||||
'''
|
||||
The thread to toot the status to mastodon.
|
||||
'''
|
||||
def __init__(self, status, timestamp, config):
|
||||
'''
|
||||
param1: boolean
|
||||
param2: integer
|
||||
param3: dictionary
|
||||
'''
|
||||
threading.Thread.__init__(self)
|
||||
self.status = status
|
||||
self.config = config
|
||||
self.timestamp = timestamp
|
||||
self.api = '/api/v1/statuses'
|
||||
self.auth = {'Authorization': ''}
|
||||
self.data = {'status': ''}
|
||||
self.url = ''
|
||||
|
||||
def run(self):
|
||||
'''
|
||||
return: boolean
|
||||
'''
|
||||
timeformat = '%d.%m.%Y %H:%M Uhr'
|
||||
# check if status is valid
|
||||
if self.status not in (True, False):
|
||||
logging.error('Invalid status to toot')
|
||||
return False
|
||||
# convert seconds into timestring
|
||||
try:
|
||||
timestring = strftime(timeformat, localtime(self.timestamp))
|
||||
except Exception as e:
|
||||
logging.error('Can not convert timestamp into timestring')
|
||||
return False
|
||||
# set status message
|
||||
if self.status == True:
|
||||
self.data['status'] = 'Krautspace is open since: {}'.format(timestring)
|
||||
elif self.status == False:
|
||||
self.data['status'] = 'Krautspace is closed since: {}'.format(timestring)
|
||||
logging.debug('Message: {}'.format(self.data['status']))
|
||||
# build mastodon api url
|
||||
self.url = join_path(self.config['mastodon']['host'], self.api)
|
||||
# build authentcation header
|
||||
self.auth['Authorization'] = 'Bearer {}'.format(
|
||||
self.config['mastodon']['token'])
|
||||
# and finaly send request to mastodon
|
||||
try:
|
||||
logging.debug('Try to toot status')
|
||||
response = requests.post(self.url, data = self.data,
|
||||
headers = self.auth)
|
||||
if response.status_code == 200:
|
||||
logging.info('Toot successful send')
|
||||
return True
|
||||
else:
|
||||
logging.error('Failed to toot. Response: {}'.format(response.status_code))
|
||||
except Exception as e:
|
||||
logging.error('Exception occurred: {}'.format(e))
|
||||
return False
|
||||
|
||||
def main():
|
||||
'''
|
||||
The main function - open a socket, create a ssl context, load certs and
|
||||
listen for connections. At SSL context we set only one available cipher
|
||||
suite and disable compression.
|
||||
OP_NO_COMPRESSION: prevention against CRIME attack
|
||||
OP_DONT_ISERT_EMPTY_FRAGMENTS: prevention agains CBC 4 attack
|
||||
(cve-2011-3389)
|
||||
'''
|
||||
answer = '3'.encode(encoding='utf-8', errors='strict')
|
||||
loglevel = logging.INFO
|
||||
formatstring = '%(asctime)s: %(levelname)s: %(message)s'
|
||||
logging.basicConfig(format=formatstring, level=loglevel)
|
||||
|
||||
default_config = {
|
||||
'general': {
|
||||
'timeout': 3.0,
|
||||
'loglevel': 'info'
|
||||
},
|
||||
'server': {
|
||||
'host': 'localhost',
|
||||
'port': 10001,
|
||||
'cert': './certs/server.crt',
|
||||
'key': './certs/server.key'
|
||||
},
|
||||
'client': {
|
||||
'cert': './certs/client.crt',
|
||||
'required': 'true'
|
||||
},
|
||||
'api': {
|
||||
'api': './api',
|
||||
'template': './api_template'
|
||||
},
|
||||
'mastodon': {
|
||||
'send': 'false',
|
||||
'host': 'localhost',
|
||||
'token': 'aaaaa-bbbbb-ccccc-ddddd-eeeee'
|
||||
}
|
||||
}
|
||||
logging.info('Try to read config file')
|
||||
configfile = './apistatusd.conf'
|
||||
config = configparser.ConfigParser()
|
||||
config.read_dict(default_config)
|
||||
if not config.read(configfile):
|
||||
logging.warning('Configuration file %s not found or not readable. Using default values.',
|
||||
configfile)
|
||||
|
||||
logger = logging.getLogger()
|
||||
if not config['general']['loglevel'] in ('critical', 'error', 'warning', 'info', 'debug'):
|
||||
logging.warning('Invalid loglevel %s given. Using default level %s.',
|
||||
config['general']['loglevel'],
|
||||
default_config['general']['loglevel'])
|
||||
config.set('general', 'loglevel', default_config['general']['loglevel'])
|
||||
|
||||
logging.info('Set loglevel to {}'.format(config['general']['loglevel'].upper()))
|
||||
logger.setLevel(config['general']['loglevel'].upper())
|
||||
|
||||
print_config(config)
|
||||
|
||||
# todo: zertifikate sollten nur lesbar sein!
|
||||
if not certs_readable(config):
|
||||
logging.error('Cert check failed\nExit')
|
||||
sys.exit(1)
|
||||
|
||||
# ssl context erstellen
|
||||
context = create_ssl_context(config)
|
||||
if context is not None:
|
||||
print_context(context)
|
||||
else: sys.exit(2)
|
||||
|
||||
try:
|
||||
# tcp socket öffnen => MySocket
|
||||
with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as MySocket:
|
||||
logging.debug('TCP Socket created')
|
||||
MySocket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
||||
MySocket.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
|
||||
keep = MySocket.getsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE)
|
||||
logging.debug('Socket keepalive: {}'.format(keep))
|
||||
try:
|
||||
MySocket.bind((config['server']['host'], int(config['server']['port'])))
|
||||
MySocket.listen(5)
|
||||
logging.info('Listening on {} at Port {}'.format(config['server']['host'],
|
||||
config['server']['port']))
|
||||
except Exception as e:
|
||||
logging.error('Unable to bind and listen')
|
||||
logging.error('{}'.format(e))
|
||||
sys.exit(3)
|
||||
# endlos auf verbindungen warten => ClientSocket
|
||||
while True:
|
||||
ClientSocket, ClientAddress = MySocket.accept()
|
||||
logging.info('Client connected: {}:{}'.format(ClientAddress[0], ClientAddress[1]))
|
||||
# die verbindung in den ssl-context verpacken => Connection
|
||||
try:
|
||||
Connection = context.wrap_socket(ClientSocket, server_side=True)
|
||||
logging.info('SSL Connection established')
|
||||
Connection.settimeout(float(config['general']['timeout']))
|
||||
logging.debug('Connection timeout set to {}'.format(config['general']['timeout']))
|
||||
cert = Connection.getpeercert(binary_form=False)
|
||||
display_peercert(cert)
|
||||
except Exception as e:
|
||||
logging.error('Unexpected error: {}'.format(e))
|
||||
continue
|
||||
# empfangen und antworten
|
||||
raw_data = Connection.recv(1)
|
||||
if receive_buffer_is_valid(raw_data) is True:
|
||||
status, timestamp = get_status_and_time(raw_data)
|
||||
if change_status(status, timestamp, config['api']['api']) is True:
|
||||
answer = raw_data
|
||||
if config['mastodon']['send'].lower() == 'true':
|
||||
logging.debug('Toot is set to true')
|
||||
try:
|
||||
toot_thread = Toot(status, timestamp, config)
|
||||
toot_thread.run()
|
||||
except InitException as e:
|
||||
logging.error('InitException: {}'.format(e))
|
||||
except Exception as ex:
|
||||
logging.debug('Exception: {}'.format(ex))
|
||||
else: logging.debug('Toot is set to false')
|
||||
logging.debug('Send {} back'.format(raw_data))
|
||||
Connection.send(answer)
|
||||
Connection.close()
|
||||
except KeyboardInterrupt:
|
||||
logging.info('Keyboard interrupt received')
|
||||
if MySocket:
|
||||
MySocket.close()
|
||||
logging.debug('TCP socket closed')
|
||||
sys.exit(255)
|
||||
except Exception as e:
|
||||
logging.error('{}'.format(e))
|
||||
if MySocket:
|
||||
MySocket.close()
|
||||
logging.debug('TCP socket closed')
|
||||
sys.exit(254)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
|
@ -4,8 +4,9 @@ After=systemd-network.service network.target
|
|||
|
||||
[Service]
|
||||
Type=simple
|
||||
Restart=on-failure
|
||||
WorkingDirectory=/opt/doorstatus/
|
||||
ExecStart=/opt/doorstatus/statusd.py
|
||||
ExecStart=/opt/doorstatus/apistatusd.py
|
||||
SyslogIdentifier=doorstatus
|
||||
User=doorstatus
|
||||
Group=doorstatus
|
|
@ -9,8 +9,7 @@
|
|||
# krautspaces doorstatus.
|
||||
|
||||
# client, who connects to the statusserver at port 10001 to update the
|
||||
# krautspace door status. If no status is given as argument, he reads from
|
||||
# stdin until input is 0 or 1.
|
||||
# krautspace door status.
|
||||
|
||||
import os
|
||||
import ssl
|
||||
|
@ -58,16 +57,19 @@ class SetStatus:
|
|||
|
||||
def check_status(self):
|
||||
"""
|
||||
checkes, if the self.status variable is a valid value
|
||||
return: boolean
|
||||
"""
|
||||
if self.status in (0, 1):
|
||||
self.log.debug('Set value to {}'.format(self.status))
|
||||
self.status = bytes([self.status])
|
||||
if self.status in ('0', '1'):
|
||||
self.log.debug('Set status to {}'.format(self.status))
|
||||
return True
|
||||
self.log.debug('{} is not a valid status'.format(self.status))
|
||||
return False
|
||||
|
||||
def set_config(self):
|
||||
"""
|
||||
Tries to read and use the values from the configuration file. If
|
||||
this failes, we still use the default values.
|
||||
"""
|
||||
self.log = logging.getLogger()
|
||||
# read config file
|
||||
|
@ -89,7 +91,8 @@ class SetStatus:
|
|||
|
||||
def check_certs(self, certs):
|
||||
"""
|
||||
Check if certs readable.
|
||||
Check if certs are readable.
|
||||
return: boolean
|
||||
"""
|
||||
self.log.debug('Check certificates')
|
||||
for certfile in certs:
|
||||
|
@ -111,25 +114,28 @@ class SetStatus:
|
|||
|
||||
def create_ssl_context(self):
|
||||
"""
|
||||
Creates SSL context
|
||||
return: context object or false
|
||||
"""
|
||||
context = ssl.create_default_context(ssl.Purpose.SERVER_AUTH,
|
||||
cafile=self.config['server']['cert'])
|
||||
if not context:
|
||||
try:
|
||||
context = ssl.create_default_context(purpose=ssl.Purpose.SERVER_AUTH)
|
||||
except Exception as e:
|
||||
self.log.error('Failed to create SSL Context')
|
||||
return False
|
||||
context.load_verify_locations(cafile=self.config['server']['cert'])
|
||||
context.load_cert_chain(certfile=self.config['client']['cert'],
|
||||
keyfile=self.config['client']['key'])
|
||||
context.set_ciphers('EECDH+AESGCM') # only ciphers for tls 1.2 and 1.3
|
||||
context.options |= getattr(ssl._ssl, 'OP_NO_COMPRESSION', 0)
|
||||
try:
|
||||
context.load_cert_chain(certfile=self.config['client']['cert'],
|
||||
keyfile=self.config['client']['key'])
|
||||
except Exception as e:
|
||||
self.log.error('Failed to load cert chain')
|
||||
return False;
|
||||
self.log.debug('SSL context created')
|
||||
return context
|
||||
|
||||
def create_ssl_socket(self, config, context):
|
||||
"""
|
||||
Opens a socket and wrapes the socket into the given ssl context.
|
||||
param1: dictionary
|
||||
param2: ssl context
|
||||
return: ssl-socket or false
|
||||
"""
|
||||
bare_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0)
|
||||
if not bare_socket:
|
||||
|
@ -192,7 +198,6 @@ class SetStatus:
|
|||
|
||||
# check given status
|
||||
if self.check_status() is False:
|
||||
self.log.error('No valid status given')
|
||||
exit(1)
|
||||
|
||||
# log config if level is debug
|
||||
|
@ -211,18 +216,20 @@ class SetStatus:
|
|||
if self.context is False:
|
||||
exit(3)
|
||||
|
||||
# get connection
|
||||
# get a ssl encrypted connection
|
||||
self.connection = self.create_ssl_connection()
|
||||
|
||||
# send status
|
||||
try:
|
||||
self.log.debug('Send new status: {}'.format(self.status))
|
||||
self.connection.send(self.status)
|
||||
self.connection.send(self.status.encode(encoding='utf-8',
|
||||
errors='strict'))
|
||||
except Exception as e:
|
||||
self.log.error('Error: {}'.format(e))
|
||||
exit(6)
|
||||
try:
|
||||
response = self.connection.recv(1)
|
||||
response = self.connection.recv(1).decode(encoding='utf-8',
|
||||
errors='strict')
|
||||
self.log.debug('Server returns: {}'.format(response))
|
||||
if response == self.status:
|
||||
self.log.info('Status sucessfull updated')
|
||||
|
@ -233,3 +240,12 @@ class SetStatus:
|
|||
self.log.error('Error: {}'.format(e))
|
||||
exit(7)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
s = SetStatus()
|
||||
if len(argv) < 2:
|
||||
log.error('Usage: setstatus.py <0|1>')
|
||||
exit(255)
|
||||
else:
|
||||
s.run(argv[1])
|
||||
|
Loading…
Reference in a new issue