Compare commits
18 Commits
74752bedf1
...
main
Author | SHA1 | Date | |
---|---|---|---|
f408c6a5fa | |||
2d01ed07bd | |||
08e74f744c | |||
d1f474b54a | |||
006423c856 | |||
0c4b009af9 | |||
b3ab871155 | |||
ec7fc82c08 | |||
659db60797 | |||
00133fc217 | |||
1ca907dfe3 | |||
451d848255 | |||
ba3454763a | |||
93b5151815 | |||
a2735194c9 | |||
2bd52ec375 | |||
e5fa39a697 | |||
e68deb61d7 |
1
.gitmodules
vendored
@ -2,3 +2,4 @@
|
||||
path = themes/blowfish
|
||||
url = https://github.com/nunocoracao/blowfish.git
|
||||
branch = main
|
||||
shallow = true
|
||||
|
550
LICENSE
@ -1,235 +1,427 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
Attribution-ShareAlike 4.0 International
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||
does not provide legal services or legal advice. Distribution of
|
||||
Creative Commons public licenses does not create a lawyer-client or
|
||||
other relationship. Creative Commons makes its licenses and related
|
||||
information available on an "as-is" basis. Creative Commons gives no
|
||||
warranties regarding its licenses, any material licensed under their
|
||||
terms and conditions, or any related information. Creative Commons
|
||||
disclaims all liability for damages resulting from their use to the
|
||||
fullest extent possible.
|
||||
|
||||
Using Creative Commons Public Licenses
|
||||
|
||||
Creative Commons public licenses provide a standard set of terms and
|
||||
conditions that creators and other rights holders may use to share
|
||||
original works of authorship and other material subject to copyright
|
||||
and certain other rights specified in the public license below. The
|
||||
following considerations are for informational purposes only, are not
|
||||
exhaustive, and do not form part of our licenses.
|
||||
|
||||
Considerations for licensors: Our public licenses are
|
||||
intended for use by those authorized to give the public
|
||||
permission to use material in ways otherwise restricted by
|
||||
copyright and certain other rights. Our licenses are
|
||||
irrevocable. Licensors should read and understand the terms
|
||||
and conditions of the license they choose before applying it.
|
||||
Licensors should also secure all rights necessary before
|
||||
applying our licenses so that the public can reuse the
|
||||
material as expected. Licensors should clearly mark any
|
||||
material not subject to the license. This includes other CC-
|
||||
licensed material, or material used under an exception or
|
||||
limitation to copyright. More considerations for licensors:
|
||||
wiki.creativecommons.org/Considerations_for_licensors
|
||||
|
||||
Considerations for the public: By using one of our public
|
||||
licenses, a licensor grants the public permission to use the
|
||||
licensed material under specified terms and conditions. If
|
||||
the licensor's permission is not necessary for any reason--for
|
||||
example, because of any applicable exception or limitation to
|
||||
copyright--then that use is not regulated by the license. Our
|
||||
licenses grant only permissions under copyright and certain
|
||||
other rights that a licensor has authority to grant. Use of
|
||||
the licensed material may still be restricted for other
|
||||
reasons, including because others have copyright or other
|
||||
rights in the material. A licensor may make special requests,
|
||||
such as asking that all changes be marked or described.
|
||||
Although not required by our licenses, you are encouraged to
|
||||
respect those requests where reasonable. More_considerations
|
||||
for the public:
|
||||
wiki.creativecommons.org/Considerations_for_licensees
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons Attribution-ShareAlike 4.0 International Public
|
||||
License
|
||||
|
||||
By exercising the Licensed Rights (defined below), You accept and agree
|
||||
to be bound by the terms and conditions of this Creative Commons
|
||||
Attribution-ShareAlike 4.0 International Public License ("Public
|
||||
License"). To the extent this Public License may be interpreted as a
|
||||
contract, You are granted the Licensed Rights in consideration of Your
|
||||
acceptance of these terms and conditions, and the Licensor grants You
|
||||
such rights in consideration of benefits the Licensor receives from
|
||||
making the Licensed Material available under these terms and
|
||||
conditions.
|
||||
|
||||
|
||||
Section 1 -- Definitions.
|
||||
|
||||
a. Adapted Material means material subject to Copyright and Similar
|
||||
Rights that is derived from or based upon the Licensed Material
|
||||
and in which the Licensed Material is translated, altered,
|
||||
arranged, transformed, or otherwise modified in a manner requiring
|
||||
permission under the Copyright and Similar Rights held by the
|
||||
Licensor. For purposes of this Public License, where the Licensed
|
||||
Material is a musical work, performance, or sound recording,
|
||||
Adapted Material is always produced where the Licensed Material is
|
||||
synched in timed relation with a moving image.
|
||||
|
||||
b. Adapter's License means the license You apply to Your Copyright
|
||||
and Similar Rights in Your contributions to Adapted Material in
|
||||
accordance with the terms and conditions of this Public License.
|
||||
|
||||
c. BY-SA Compatible License means a license listed at
|
||||
creativecommons.org/compatiblelicenses, approved by Creative
|
||||
Commons as essentially the equivalent of this Public License.
|
||||
|
||||
d. Copyright and Similar Rights means copyright and/or similar rights
|
||||
closely related to copyright including, without limitation,
|
||||
performance, broadcast, sound recording, and Sui Generis Database
|
||||
Rights, without regard to how the rights are labeled or
|
||||
categorized. For purposes of this Public License, the rights
|
||||
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||
Rights.
|
||||
|
||||
e. Effective Technological Measures means those measures that, in the
|
||||
absence of proper authority, may not be circumvented under laws
|
||||
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||
Treaty adopted on December 20, 1996, and/or similar international
|
||||
agreements.
|
||||
|
||||
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||
any other exception or limitation to Copyright and Similar Rights
|
||||
that applies to Your use of the Licensed Material.
|
||||
|
||||
g. License Elements means the license attributes listed in the name
|
||||
of a Creative Commons Public License. The License Elements of this
|
||||
Public License are Attribution and ShareAlike.
|
||||
|
||||
h. Licensed Material means the artistic or literary work, database,
|
||||
or other material to which the Licensor applied this Public
|
||||
License.
|
||||
|
||||
i. Licensed Rights means the rights granted to You subject to the
|
||||
terms and conditions of this Public License, which are limited to
|
||||
all Copyright and Similar Rights that apply to Your use of the
|
||||
Licensed Material and that the Licensor has authority to license.
|
||||
|
||||
j. Licensor means the individual(s) or entity(ies) granting rights
|
||||
under this Public License.
|
||||
|
||||
k. Share means to provide material to the public by any means or
|
||||
process that requires permission under the Licensed Rights, such
|
||||
as reproduction, public display, public performance, distribution,
|
||||
dissemination, communication, or importation, and to make material
|
||||
available to the public including in ways that members of the
|
||||
public may access the material from a place and at a time
|
||||
individually chosen by them.
|
||||
|
||||
l. Sui Generis Database Rights means rights other than copyright
|
||||
resulting from Directive 96/9/EC of the European Parliament and of
|
||||
the Council of 11 March 1996 on the legal protection of databases,
|
||||
as amended and/or succeeded, as well as other essentially
|
||||
equivalent rights anywhere in the world.
|
||||
|
||||
m. You means the individual or entity exercising the Licensed Rights
|
||||
under this Public License. Your has a corresponding meaning.
|
||||
|
||||
|
||||
Section 2 -- Scope.
|
||||
|
||||
a. License grant.
|
||||
|
||||
1. Subject to the terms and conditions of this Public License,
|
||||
the Licensor hereby grants You a worldwide, royalty-free,
|
||||
non-sublicensable, non-exclusive, irrevocable license to
|
||||
exercise the Licensed Rights in the Licensed Material to:
|
||||
|
||||
a. reproduce and Share the Licensed Material, in whole or
|
||||
in part; and
|
||||
|
||||
b. produce, reproduce, and Share Adapted Material.
|
||||
|
||||
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||
Exceptions and Limitations apply to Your use, this Public
|
||||
License does not apply, and You do not need to comply with
|
||||
its terms and conditions.
|
||||
|
||||
3. Term. The term of this Public License is specified in Section
|
||||
6(a).
|
||||
|
||||
4. Media and formats; technical modifications allowed. The
|
||||
Licensor authorizes You to exercise the Licensed Rights in
|
||||
all media and formats whether now known or hereafter created,
|
||||
and to make technical modifications necessary to do so. The
|
||||
Licensor waives and/or agrees not to assert any right or
|
||||
authority to forbid You from making technical modifications
|
||||
necessary to exercise the Licensed Rights, including
|
||||
technical modifications necessary to circumvent Effective
|
||||
Technological Measures. For purposes of this Public License,
|
||||
simply making modifications authorized by this Section 2(a)
|
||||
(4) never produces Adapted Material.
|
||||
|
||||
5. Downstream recipients.
|
||||
|
||||
a. Offer from the Licensor -- Licensed Material. Every
|
||||
recipient of the Licensed Material automatically
|
||||
receives an offer from the Licensor to exercise the
|
||||
Licensed Rights under the terms and conditions of this
|
||||
Public License.
|
||||
|
||||
b. Additional offer from the Licensor -- Adapted Material.
|
||||
Every recipient of Adapted Material from You
|
||||
automatically receives an offer from the Licensor to
|
||||
exercise the Licensed Rights in the Adapted Material
|
||||
under the conditions of the Adapter's License You apply.
|
||||
|
||||
c. No downstream restrictions. You may not offer or impose
|
||||
any additional or different terms or conditions on, or
|
||||
apply any Effective Technological Measures to, the
|
||||
Licensed Material if doing so restricts exercise of the
|
||||
Licensed Rights by any recipient of the Licensed
|
||||
Material.
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
6. No endorsement. Nothing in this Public License constitutes or
|
||||
may be construed as permission to assert or imply that You
|
||||
are, or that Your use of the Licensed Material is, connected
|
||||
with, or sponsored, endorsed, or granted official status by,
|
||||
the Licensor or others designated to receive attribution as
|
||||
provided in Section 3(a)(1)(A)(i).
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||
b. Other rights.
|
||||
|
||||
Preamble
|
||||
1. Moral rights, such as the right of integrity, are not
|
||||
licensed under this Public License, nor are publicity,
|
||||
privacy, and/or other similar personality rights; however, to
|
||||
the extent possible, the Licensor waives and/or agrees not to
|
||||
assert any such rights held by the Licensor to the limited
|
||||
extent necessary to allow You to exercise the Licensed
|
||||
Rights, but not otherwise.
|
||||
|
||||
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.
|
||||
2. Patent and trademark rights are not licensed under this
|
||||
Public License.
|
||||
|
||||
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.
|
||||
3. To the extent possible, the Licensor waives any right to
|
||||
collect royalties from You for the exercise of the Licensed
|
||||
Rights, whether directly or through a collecting society
|
||||
under any voluntary or waivable statutory or compulsory
|
||||
licensing scheme. In all other cases the Licensor expressly
|
||||
reserves any right to collect such royalties.
|
||||
|
||||
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.
|
||||
Section 3 -- License Conditions.
|
||||
|
||||
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.
|
||||
Your exercise of the Licensed Rights is expressly made subject to the
|
||||
following conditions.
|
||||
|
||||
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.
|
||||
a. Attribution.
|
||||
|
||||
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.
|
||||
1. If You Share the Licensed Material (including in modified
|
||||
form), You must:
|
||||
|
||||
The precise terms and conditions for copying, distribution and modification follow.
|
||||
a. retain the following if it is supplied by the Licensor
|
||||
with the Licensed Material:
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
i. identification of the creator(s) of the Licensed
|
||||
Material and any others designated to receive
|
||||
attribution, in any reasonable manner requested by
|
||||
the Licensor (including by pseudonym if
|
||||
designated);
|
||||
|
||||
0. Definitions.
|
||||
ii. a copyright notice;
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
iii. a notice that refers to this Public License;
|
||||
|
||||
iv. a notice that refers to the disclaimer of
|
||||
warranties;
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
||||
v. a URI or hyperlink to the Licensed Material to the
|
||||
extent reasonably practicable;
|
||||
|
||||
"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.
|
||||
b. indicate if You modified the Licensed Material and
|
||||
retain an indication of any previous modifications; and
|
||||
|
||||
c. indicate the Licensed Material is licensed under this
|
||||
Public License, and include the text of, or the URI or
|
||||
hyperlink to, this Public License.
|
||||
|
||||
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.
|
||||
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||
reasonable manner based on the medium, means, and context in
|
||||
which You Share the Licensed Material. For example, it may be
|
||||
reasonable to satisfy the conditions by providing a URI or
|
||||
hyperlink to a resource that includes the required
|
||||
information.
|
||||
|
||||
3. If requested by the Licensor, You must remove any of the
|
||||
information required by Section 3(a)(1)(A) to the extent
|
||||
reasonably practicable.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based on the Program.
|
||||
b. ShareAlike.
|
||||
|
||||
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.
|
||||
In addition to the conditions in Section 3(a), if You Share
|
||||
Adapted Material You produce, the following conditions also apply.
|
||||
|
||||
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.
|
||||
1. The Adapter's License You apply must be a Creative Commons
|
||||
license with the same License Elements, this version or
|
||||
later, or a BY-SA Compatible License.
|
||||
|
||||
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.
|
||||
2. You must include the text of, or the URI or hyperlink to, the
|
||||
Adapter's License You apply. You may satisfy this condition
|
||||
in any reasonable manner based on the medium, means, and
|
||||
context in which You Share Adapted Material.
|
||||
|
||||
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.
|
||||
3. You may not offer or impose any additional or different terms
|
||||
or conditions on, or apply any Effective Technological
|
||||
Measures to, Adapted Material that restrict exercise of the
|
||||
rights granted under the Adapter's License You apply.
|
||||
|
||||
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.
|
||||
Section 4 -- Sui Generis Database Rights.
|
||||
|
||||
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.
|
||||
Where the Licensed Rights include Sui Generis Database Rights that
|
||||
apply to Your use of the Licensed Material:
|
||||
|
||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||
to extract, reuse, reproduce, and Share all or a substantial
|
||||
portion of the contents of the database;
|
||||
|
||||
The Corresponding Source for a work in source code form is that same work.
|
||||
b. if You include all or a substantial portion of the database
|
||||
contents in a database in which You have Sui Generis Database
|
||||
Rights, then the database in which You have Sui Generis Database
|
||||
Rights (but not its individual contents) is Adapted Material,
|
||||
|
||||
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.
|
||||
including for purposes of Section 3(b); and
|
||||
c. You must comply with the conditions in Section 3(a) if You Share
|
||||
all or a substantial portion of the contents of the database.
|
||||
|
||||
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.
|
||||
For the avoidance of doubt, this Section 4 supplements and does not
|
||||
replace Your obligations under this Public License where the Licensed
|
||||
Rights include other Copyright and Similar Rights.
|
||||
|
||||
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.
|
||||
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||
|
||||
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.
|
||||
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||
|
||||
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.
|
||||
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||
|
||||
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.
|
||||
c. The disclaimer of warranties and limitation of liability provided
|
||||
above shall be interpreted in a manner that, to the extent
|
||||
possible, most closely approximates an absolute disclaimer and
|
||||
waiver of all liability.
|
||||
|
||||
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.
|
||||
Section 6 -- Term and Termination.
|
||||
|
||||
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".
|
||||
a. This Public License applies for the term of the Copyright and
|
||||
Similar Rights licensed here. However, if You fail to comply with
|
||||
this Public License, then Your rights under this Public License
|
||||
terminate automatically.
|
||||
|
||||
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.
|
||||
b. Where Your right to use the Licensed Material has terminated under
|
||||
Section 6(a), it reinstates:
|
||||
|
||||
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.
|
||||
1. automatically as of the date the violation is cured, provided
|
||||
it is cured within 30 days of Your discovery of the
|
||||
violation; or
|
||||
|
||||
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.
|
||||
2. upon express reinstatement by the Licensor.
|
||||
|
||||
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:
|
||||
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||
right the Licensor may have to seek remedies for Your violations
|
||||
of this Public License.
|
||||
|
||||
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.
|
||||
c. For the avoidance of doubt, the Licensor may also offer the
|
||||
Licensed Material under separate terms or conditions or stop
|
||||
distributing the Licensed Material at any time; however, doing so
|
||||
will not terminate this Public License.
|
||||
|
||||
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.
|
||||
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||
License.
|
||||
|
||||
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.
|
||||
Section 7 -- Other Terms and Conditions.
|
||||
|
||||
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. The Licensor shall not be bound by any additional or different
|
||||
terms or conditions communicated by You unless expressly agreed.
|
||||
|
||||
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.
|
||||
b. Any arrangements, understandings, or agreements regarding the
|
||||
Licensed Material not stated herein are separate from and
|
||||
independent of the terms and conditions of this Public License.
|
||||
|
||||
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.
|
||||
Section 8 -- Interpretation.
|
||||
|
||||
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).
|
||||
a. For the avoidance of doubt, this Public License does not, and
|
||||
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||
conditions on any use of the Licensed Material that could lawfully
|
||||
be made without permission under this Public License.
|
||||
|
||||
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.
|
||||
b. To the extent possible, if any provision of this Public License is
|
||||
deemed unenforceable, it shall be automatically reformed to the
|
||||
minimum extent necessary to make it enforceable. If the provision
|
||||
cannot be reformed, it shall be severed from this Public License
|
||||
without affecting the enforceability of the remaining terms and
|
||||
conditions.
|
||||
|
||||
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.
|
||||
c. No term or condition of this Public License will be waived and no
|
||||
failure to comply consented to unless expressly agreed to by the
|
||||
Licensor.
|
||||
|
||||
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.
|
||||
d. Nothing in this Public License constitutes or may be interpreted
|
||||
as a limitation upon, or waiver of, any privileges and immunities
|
||||
that apply to the Licensor or You, including from the legal
|
||||
processes of any jurisdiction or authority.
|
||||
|
||||
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:
|
||||
=======================================================================
|
||||
|
||||
Creative Commons is not a party to its public
|
||||
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||
its public licenses to material it publishes and in those instances
|
||||
will be considered the “Licensor.” The text of the Creative Commons
|
||||
public licenses is dedicated to the public domain under the CC0 Public
|
||||
Domain Dedication. Except for the limited purpose of indicating that
|
||||
material is shared under a Creative Commons public license or as
|
||||
otherwise permitted by the Creative Commons policies published at
|
||||
creativecommons.org/policies, Creative Commons does not authorize the
|
||||
use of the trademark "Creative Commons" or any other trademark or logo
|
||||
of Creative Commons without its prior written consent including,
|
||||
without limitation, in connection with any unauthorized modifications
|
||||
to any of its public licenses or any other arrangements,
|
||||
understandings, or agreements concerning use of licensed material. For
|
||||
the avoidance of doubt, this paragraph does not form part of the
|
||||
public licenses.
|
||||
|
||||
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.
|
||||
|
||||
blog
|
||||
Copyright (C) 2024 nicolabelluti
|
||||
|
||||
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/>.
|
||||
Creative Commons may be contacted at creativecommons.org.
|
||||
|
11
README.md
@ -1,5 +1,16 @@
|
||||
<div align="center">
|
||||
|
||||
# Blog 🌐
|
||||
|
||||
[](https://www.gohugo.io)
|
||||
[](https://brainmade.org)
|
||||
[](https://choosealicense.com/licenses/cc-by-sa-4.0/)
|
||||
[](https://buymeacoffee.com/nicolabelluti)
|
||||
<br>
|
||||
[](https://git.nicolabelluti.me/nicolabelluti/blog/actions/?workflow=build-and-publish.yaml)
|
||||
|
||||
</div><br>
|
||||
|
||||
> My personal blog, powered by [Hugo](https://gohugo.io/) and the
|
||||
> [Blowfish](https://blowfish.page/) theme
|
||||
|
||||
|
Before Width: | Height: | Size: 160 KiB |
@ -9,20 +9,22 @@ languageName = "English"
|
||||
|
||||
copyright = """ \
|
||||
Made by **Nicola Belluti** with ❤️ | \
|
||||
[*GNU AGPLv3.0 license*](https://git.nicolabelluti.me/nicolabelluti/blog/src/branch/main/LICENSE) \
|
||||
[*CC BY-SA 4.0 license*](https://creativecommons.org/licenses/by-sa/4.0/) \
|
||||
"""
|
||||
|
||||
[author]
|
||||
[params.author]
|
||||
name = "Nicola Belluti"
|
||||
image = "/img/avatar.jpg"
|
||||
headline = "Coding while listening to good music 🧑🏻💻"
|
||||
bio = """ \
|
||||
An IT guy in love with the open source world. \
|
||||
[***About me...***](/about-me) \
|
||||
"""
|
||||
links = [
|
||||
{ code = "https://git.nicolabelluti.me/nicolabelluti" },
|
||||
{ email = "mailto:nicolabelluti@protonmail.com" },
|
||||
{ gitea = "https://git.nicolabelluti.me/nicolabelluti" },
|
||||
{ github = "https://github.com/nicolabelluti" },
|
||||
{ reddit = "https://reddit.com/u/nicola-belluti" },
|
||||
{ instagram = "https://instagram.com/nicola.belluti" },
|
||||
{ email = "mailto:me [at] [this domain]" },
|
||||
{ telegram = "https://t.me/nicolabelluti" },
|
||||
{ mug-hot = "https://buymeacoffee.com/nicolabelluti" },
|
||||
{ rss = "/index.xml" },
|
||||
|
@ -9,20 +9,22 @@ languageName = "Italiano"
|
||||
|
||||
copyright = """ \
|
||||
Fatto da **Nicola Belluti** col ❤️ | \
|
||||
[*Licenza GNU AGPLv3.0*](https://git.nicolabelluti.me/nicolabelluti/blog/src/branch/main/LICENSE) \
|
||||
[*Licenza CC BY-SA*](https://creativecommons.org/licenses/by-sa/4.0/) \
|
||||
"""
|
||||
|
||||
[author]
|
||||
[params.author]
|
||||
name = "Nicola Belluti"
|
||||
image = "/img/avatar.jpg"
|
||||
headline = "Coding while listening to good music 🧑🏻💻"
|
||||
bio = """ \
|
||||
Un ragazzo innamorato del mondo open source. \
|
||||
[***Su di me...***](/it/about-me) \
|
||||
"""
|
||||
links = [
|
||||
{ code = "https://git.nicolabelluti.me/nicolabelluti" },
|
||||
{ email = "mailto:nicolabelluti@protonmail.com" },
|
||||
{ gitea = "https://git.nicolabelluti.me/nicolabelluti" },
|
||||
{ github = "https://github.com/nicolabelluti" },
|
||||
{ reddit = "https://reddit.com/u/nicola-belluti" },
|
||||
{ instagram = "https://instagram.com/nicola.belluti" },
|
||||
{ email = "mailto:me [chiocciola] [questo dominio]" },
|
||||
{ telegram = "https://t.me/nicolabelluti" },
|
||||
{ mug-hot = "https://buymeacoffee.com/nicolabelluti" },
|
||||
{ rss = "/index.xml" },
|
||||
|
@ -21,7 +21,7 @@ smartTOC = true
|
||||
# Show recent posts
|
||||
showRecent = true
|
||||
cardView = true
|
||||
showRecentItems = 9
|
||||
showRecentItems = 3
|
||||
showMoreLink = true
|
||||
showMoreLinkDest = "/posts"
|
||||
|
||||
|
@ -95,8 +95,9 @@ Niente Google, niente trackers, niente cookies.
|
||||
tutto;
|
||||
|
||||
* Il codice sorgente si trova sul [mio server
|
||||
Git](https://git.nicolabelluti.me/nicolabelluti/blog), sotto [licenza GNU
|
||||
AGPLv3.0](https://git.nicolabelluti.me/nicolabelluti/blog/src/branch/main/LICENSE);
|
||||
Git](https://git.nicolabelluti.me/nicolabelluti/blog), sotto [licenza
|
||||
Creative Commons Attribution-ShareAlike 4.0
|
||||
International](https://creativecommons.org/licenses/by-sa/4.0/);
|
||||
|
||||
* Il dominio è registrato su [Cloudflare](https://cloudflare.com/) ed è
|
||||
pubblicato grazie a [Pages](https://pages.cloudflare.com/), anche se sto
|
||||
@ -106,9 +107,11 @@ Niente Google, niente trackers, niente cookies.
|
||||
|
||||
## Webring
|
||||
|
||||
Per ora faccio parte di una sola webring, ma spero di aumentare in futuro!
|
||||
|
||||
[<---](https://geekring.net/site/377/previous)
|
||||
[Geek webring](https://geekring.net/)
|
||||
[[Random](https://geekring.net/site/377/random)]
|
||||
[--->](https://geekring.net/site/377/next)
|
||||
|
||||
[<---](https://www.dreamwingsthegriffon.com)
|
||||
[*nixRing](https://teethinvitro.neocities.org/webring/linuxring/)
|
||||
[--->](https://xx-starbrite-xx.neocities.org)
|
||||
|
@ -90,8 +90,9 @@ No Google, no trackers, no cookies.
|
||||
this.
|
||||
|
||||
* The source code is on my [Git
|
||||
server](https://git.nicolabelluti.me/nicolabelluti/blog) under the [GNU AGPLv3.0
|
||||
license](https://git.nicolabelluti.me/nicolabelluti/blog/src/branch/main/LICENSE);
|
||||
server](https://git.nicolabelluti.me/nicolabelluti/blog) under the [ Creative
|
||||
Commons Attribution-ShareAlike 4.0 International
|
||||
License](https://creativecommons.org/licenses/by-sa/4.0/);
|
||||
|
||||
* The domain is registered with [Cloudflare](https://cloudflare.com/) and is
|
||||
published thanks to [Pages](https://pages.cloudflare.com/), though I'm
|
||||
@ -99,11 +100,13 @@ No Google, no trackers, no cookies.
|
||||
provider. [A few reasons for the hate towards
|
||||
Cloudflare](https://old.reddit.com/r/privacy/comments/d52kop/)
|
||||
|
||||
## Webring
|
||||
|
||||
At the moment, I'm into a single webring, but I hope to join more in the future!
|
||||
## Webrings
|
||||
|
||||
[<---](https://geekring.net/site/377/previous)
|
||||
[Geek webring](https://geekring.net/)
|
||||
[[Random](https://geekring.net/site/377/random)]
|
||||
[--->](https://geekring.net/site/377/next)
|
||||
|
||||
[<---](https://www.dreamwingsthegriffon.com)
|
||||
[*nixRing](https://teethinvitro.neocities.org/webring/linuxring/)
|
||||
[--->](https://xx-starbrite-xx.neocities.org)
|
||||
|
Before Width: | Height: | Size: 724 KiB |
After Width: | Height: | Size: 530 KiB |
Before Width: | Height: | Size: 588 KiB After Width: | Height: | Size: 588 KiB |
Before Width: | Height: | Size: 681 KiB After Width: | Height: | Size: 681 KiB |
After Width: | Height: | Size: 500 KiB |
183
content/posts/2024/08/decrypting-an-encrypted-dmg/index.it.md
Normal file
@ -0,0 +1,183 @@
|
||||
+++
|
||||
title = "Decriptare un .dmg criptato"
|
||||
summary = "Come sbloccare un .dmg criptato su Linux (conoscendo la password)"
|
||||
date = "2024-08-13"
|
||||
|
||||
tags = ["Crittografia", "Apple", ".dmg", "Linux"]
|
||||
categories = ["Robe che ho fatto"]
|
||||
+++
|
||||
|
||||
Mi è capitato di recente di ricevere una chiavetta USB contenente un file
|
||||
`.dmg` criptato contenente dei file a cui ero interessato. Il proprietario
|
||||
della chiavetta mi ha dato la password, in modo che potessi accedere ai file.
|
||||
|
||||
Il problema rimane uno: **io non ho un Mac**.
|
||||
|
||||
Quindi, dato che sono un fiero utente **GNU/Linux** e non ho voglia di creare
|
||||
una VM MacOS (anche se su **Proxmox** sembra essere [abbastanza
|
||||
facile](https://nicksherlock.com/2022/10/installing-macos-13-ventura-on-proxmox/)),
|
||||
ho deciso di provare ad aprire il file crittato con un po' di utility e una
|
||||
buona dose di olio di gomito.
|
||||
|
||||
## Che cos'è un DMG?
|
||||
|
||||
Per i più interessati: <https://en.wikipedia.org/wiki/Apple_Disk_Image>
|
||||
|
||||
Per i pigri come me invece: un file DMG non è altro che un formato file
|
||||
propietario di Apple, utilizzato per distribuire ed installare App su MacOS, ma
|
||||
può contenere anche altre cose, come ad esempio un *file system*.
|
||||
|
||||
La cosa interessante per me è che un file DMG può essere crittato con
|
||||
**AES-128** o **AES-256**.
|
||||
|
||||
Durante la mia ricerca per la stesura di questo articolo (ovviamente solo dopo
|
||||
aver speso un'oretta buona per aprire il file) mi sono imbattuto in un articolo
|
||||
di un'altra persona interessata ai DMG criptati che ha concluso dicendo:
|
||||
|
||||
> #### Conclusion
|
||||
>
|
||||
> I wrote this post because it is too complicated (not hard, **complicated**)
|
||||
> to deal with an encrypted dmg image on another OS than MacOS.
|
||||
|
||||
Lascio il link all'ottimo articolo qua:
|
||||
<https://talebyanis.github.io/posts/how-to-deal-with-encrypted-dmg-files>
|
||||
|
||||
Concordo pienamente: sembra che Apple ce l'abbia messa tutta per rendere
|
||||
impossibile l'apertura di questo file senza avere un Mac.
|
||||
|
||||
## Decriptare un DMG criptato
|
||||
|
||||
La prima cosa che ho fatto per analizzare il file con cui stavo lavorando è
|
||||
stata utilizzare l'utility
|
||||
[*file*](https://www.man7.org/linux/man-pages/man1/file.1.html), che però ha
|
||||
dato scarsi risultati:
|
||||
|
||||
```shell
|
||||
$ file encrypted.dmg
|
||||
encrypted.dmg: data
|
||||
```
|
||||
|
||||
*No shit, Sherlock!*
|
||||
|
||||
Usando il comando `xxd` possiamo ottenere più indizi riguardo al tipo di file:
|
||||
|
||||
```shell
|
||||
$ xxd encrypted.dmg | head -n 5
|
||||
00000000: 656e 6372 6364 7361 0000 0002 0000 0010 encrcdsa........
|
||||
00000010: 0000 0005 8000 0001 0000 0080 0000 005b ...............[
|
||||
00000020: 0000 00a0 ecdb 2a00 e3a5 43a7 b839 0ebb ......*...C..9..
|
||||
00000030: 18ec 7107 0000 0200 0000 0000 6d70 0800 ..q.........mp..
|
||||
00000040: 0000 0000 0001 de00 0000 0001 0000 0001 ................
|
||||
```
|
||||
|
||||
Cercando su DuckDuckGo "*encrcdsa*" si trovano un po' di risultati, tra cui il
|
||||
post che ho citato nel [capitolo precedente](#che-cosè-un-dmg).
|
||||
|
||||
Anche senza usare un motore di ricerca, possiamo capire che il file è criptato
|
||||
e bisogna trovare un modo per decriptarlo.
|
||||
|
||||
Cercando su Internet con query come "*linux dmg decrypt*" si possono trovare
|
||||
molte risposte, ma nessuna funzionante, tra le quali spiccano:
|
||||
|
||||
1. Usare [7zip](https://7-zip.org): non riesce a gestire i DMG criptati;
|
||||
2. Usare [dmg2img](https://github.com/Lekensteyn/dmg2img): non riesce a gestire
|
||||
i DMG criptati;
|
||||
|
||||
Ho cercato per un po' finchè non ho trovato
|
||||
[dmgwiz](https://github.com/citruz/dmgwiz), uno strumento scritto in Rust
|
||||
(***Rust FTW!***) nato come clone di `dmg2img` ma che permette, fra le varie
|
||||
cose, di leggere i DMG criptati!
|
||||
|
||||
---
|
||||
|
||||
Per utilizzare `dmgwiz` bisogna prima scaricare il binario dalle
|
||||
[Release della pagina GitHub](https://github.com/citruz/dmgwiz/releases/latest)
|
||||
del progetto.
|
||||
|
||||
Dopo di che possiamo decriptare il nostro DMG col seguente comando:
|
||||
|
||||
```shell
|
||||
$ ./dmgwiz.elf encrypted.dmg -p "<password>" decrypt -o output.dmg
|
||||
1836058624 bytes written
|
||||
```
|
||||
|
||||
**Hurrà!** Siamo riusciti a decpritare il DMG
|
||||
|
||||
## Estrarre i file
|
||||
|
||||
La dimensione del file decriptato corrisponde più o meno alla dimensione del
|
||||
file criptato, se però proviamo ad ottenere più informazioni sul DMG sempre con
|
||||
`dmgwiz` otteniamo un errore:
|
||||
|
||||
```shell
|
||||
$ ./dmgwiz.elf output.dmg info
|
||||
error: could not read input file - could not parse koly header
|
||||
```
|
||||
|
||||
Il che significa che i primi 4 byte del nostro file non corrispondono al
|
||||
[numero magico](https://en.wikipedia.org/wiki/File_format#Magic_number) del
|
||||
file DMG.
|
||||
|
||||
Se proviamo con l'utility `file` a scoprire il tipo di file scopriamo che...
|
||||
|
||||
```shell
|
||||
$ file output.dmg
|
||||
output.dmg: DOS/MBR boot sector; partition 1 : ID=0xee, start-CHS (0x3ff,254,63), end-CHS (0x3ff,254,63), startsector 1, 3586051 sectors, extended partition table (last)
|
||||
```
|
||||
|
||||
È un *file system*... *Interesting...*
|
||||
|
||||
Tramite `fdisk` possiamo scoprire che il *file system* in questione è
|
||||
[APFS](https://en.wikipedia.org/wiki/Apple_File_System), un *file system*
|
||||
proprietario di Apple ottimizzato per gli SSD e utilizzato come default su
|
||||
MacOS dalla versione Sierra.
|
||||
|
||||
```shell
|
||||
$ fdisk -l output.dmg
|
||||
Disk output.dmg: 1.71 GiB, 1836058624 bytes, 3586052 sectors
|
||||
Units: sectors of 1 * 512 = 512 bytes
|
||||
Sector size (logical/physical): 512 bytes / 512 bytes
|
||||
I/O size (minimum/optimal): 512 bytes / 512 bytes
|
||||
Disklabel type: gpt
|
||||
Disk identifier: 8ABB68ED-8C96-425B-B615-36926AC40D4C
|
||||
|
||||
Device Start End Sectors Size Type
|
||||
output.dmg1 40 3586015 3585976 1.7G Apple APFS
|
||||
```
|
||||
|
||||
Per montare questo *fle system* ed estrarre i file possiamo usare un drive FUSE
|
||||
per APFS: [apfs-fuse](https://github.com/sgan81/apfs-fuse); si può trovare nei
|
||||
repository della propria distribuzione.
|
||||
|
||||
Una volta installato possiamo utilizzarlo per montare il nostro *file system*:
|
||||
|
||||
```shell
|
||||
$ mkdir files/
|
||||
$ apfs-fuse output.dmg files/
|
||||
```
|
||||
|
||||
Infine possiamo verificare che il tutto sia stato montato correttamente con:
|
||||
|
||||
```shell
|
||||
$ mount | tail -n 1
|
||||
output.dmg on /home/user/files type fuse (ro,nosuid,nodev,relatime,user_id=1000,group_id=1000)
|
||||
$ ls files/
|
||||
private-dir root
|
||||
```
|
||||
|
||||
## *Post-scriptum*
|
||||
|
||||
Dopo aver scritto tutto l'articolo ho provato per curiosità a montare
|
||||
l'archivio criptato direttamente con `apfs-fuse` e ha funzionato.
|
||||
|
||||
Quindi se sapete che il contenuto del DMG è un *file system* APFS potete
|
||||
direttamente utilizzare `apfs-fuse` senza passare per `dmgwiz`.
|
||||
|
||||
## Conclusione
|
||||
|
||||
Ho deciso di scrivere questo post perchè, come ha già scritto
|
||||
[talebyanis](https://talebyanis.github.io/), aprire un DMG criptato su qualcosa
|
||||
che non sia MacOS è complicato (non difficile, **complicato**).
|
||||
|
||||
Spero di essere stato di aiuto per le pochissime persone che stanno passando il
|
||||
mio stesso problema.
|
183
content/posts/2024/08/decrypting-an-encrypted-dmg/index.md
Normal file
@ -0,0 +1,183 @@
|
||||
+++
|
||||
title = "Decrypting an Encrypted .dmg"
|
||||
summary = "How to unlock an encrypted .dmg on Linux (knowing the password)"
|
||||
date = "2024-08-13"
|
||||
|
||||
tags = ["Encryption", "Apple", ".dmg", "Linux"]
|
||||
categories = ["Things I've done"]
|
||||
+++
|
||||
|
||||
I recently got a USB stick containing an encrypted `.dmg` file with some files
|
||||
I was interested in. The owner of the USB stick gave me the password so that I
|
||||
could access the files.
|
||||
|
||||
The problem is: **I don't own a Mac**.
|
||||
|
||||
So, since I am a proud **GNU/Linux** user and don't want to create a MacOS VM
|
||||
(even though it seems to be [quite
|
||||
easy](https://nicksherlock.com/2022/10/installing-macos-13-ventura-on-proxmox/)
|
||||
on **Proxmox**), I decided to try to open the encrypted file with some
|
||||
utilities and some hard work.
|
||||
|
||||
## What is a DMG?
|
||||
|
||||
For those interested: <https://en.wikipedia.org/wiki/Apple_Disk_Image>
|
||||
|
||||
For the other lazy people like me: a DMG file is a proprietary file format from
|
||||
Apple, used to distribute and install apps on MacOS, but it can also contain
|
||||
other things, such as a file system.
|
||||
|
||||
The interesting thing for me is that a DMG file can be encrypted with
|
||||
**AES-128** or **AES-256**.
|
||||
|
||||
During my research for writing this article (of course only after spending a
|
||||
good hour trying to open the file), I came across an article by another person
|
||||
interested in encrypted DMGs who concluded by saying:
|
||||
|
||||
> #### Conclusion
|
||||
>
|
||||
> I wrote this post because it is too complicated (not hard, **complicated**)
|
||||
> to deal with an encrypted dmg image on another OS than MacOS.
|
||||
|
||||
I leave the link to the excellent article here:
|
||||
<https://talebyanis.github.io/posts/how-to-deal-with-encrypted-dmg-files>
|
||||
|
||||
I completely agree: it seems that Apple has done everything possible to make it
|
||||
impossible to open this file without having a Mac.
|
||||
|
||||
## Decrypting an Encrypted DMG
|
||||
|
||||
The first thing I did to analyze the file I was working on with was to use the
|
||||
[*file*](https://www.man7.org/linux/man-pages/man1/file.1.html) utility, which
|
||||
gave poor results:
|
||||
|
||||
```shell
|
||||
$ file encrypted.dmg
|
||||
encrypted.dmg: data
|
||||
```
|
||||
|
||||
*No shit, Sherlock!*
|
||||
|
||||
Using the `xxd` command, we can get more clues about the file:
|
||||
|
||||
```shell
|
||||
$ xxd encrypted.dmg | head -n 5
|
||||
00000000: 656e 6372 6364 7361 0000 0002 0000 0010 encrcdsa........
|
||||
00000010: 0000 0005 8000 0001 0000 0080 0000 005b ...............[
|
||||
00000020: 0000 00a0 ecdb 2a00 e3a5 43a7 b839 0ebb ......*...C..9..
|
||||
00000030: 18ec 7107 0000 0200 0000 0000 6d70 0800 ..q.........mp..
|
||||
00000040: 0000 0000 0001 de00 0000 0001 0000 0001 ................
|
||||
```
|
||||
|
||||
A quick search on DuckDuckGo for "*encrcdsa*" yields a few results, including
|
||||
the post I mentioned in the [previous chapter](#what-is-a-dmg).
|
||||
|
||||
Even without using a search engine, we can understand that the file is
|
||||
encrypted and we need to find a way to decrypt it.
|
||||
|
||||
Searching the Internet with queries like "*linux dmg decrypt*" can yield many
|
||||
answers, among which stand out:
|
||||
|
||||
1. Use [7zip](https://7-zip.org): it can't handle encrypted DMGs;
|
||||
2. Use [dmg2img](https://github.com/Lekensteyn/dmg2img): it can't handle
|
||||
encrypted DMGs;
|
||||
|
||||
I searched for a while until I found
|
||||
[dmgwiz](https://github.com/citruz/dmgwiz), a tool written in Rust (***Rust
|
||||
FTW!***) that started as a clone of `dmg2img` but allows, among other things,
|
||||
to read encrypted DMGs!
|
||||
|
||||
---
|
||||
|
||||
To use `dmgwiz`, you first need to download the binary from the [Releases
|
||||
page](https://github.com/citruz/dmgwiz/releases/latest) of the project's GitHub
|
||||
page.
|
||||
|
||||
After that, we can decrypt our DMG with the following command:
|
||||
|
||||
```shell
|
||||
$ ./dmgwiz.elf encrypted.dmg -p "<password>" decrypt -o output.dmg
|
||||
1836058624 bytes written
|
||||
```
|
||||
|
||||
**Hurray!** We managed to decrypt the DMG.
|
||||
|
||||
## Extracting the Files
|
||||
|
||||
The size of the decrypted file corresponds roughly to the size of the encrypted
|
||||
file, but if we try to get more information about the DMG using `dmgwiz`, we
|
||||
get an error:
|
||||
|
||||
```shell
|
||||
$ ./dmgwiz.elf output.dmg info
|
||||
error: could not read input file - could not parse koly header
|
||||
```
|
||||
|
||||
This means that the first 4 bytes of our file do not correspond to the [magic
|
||||
number](https://en.wikipedia.org/wiki/File_format#Magic_number) of the DMG
|
||||
file.
|
||||
|
||||
If we try to discover the type of file with the `file` utility we find out
|
||||
that...
|
||||
|
||||
```shell
|
||||
$ file output.dmg
|
||||
output.dmg: DOS/MBR boot sector; partition 1 : ID=0xee, start-CHS (0x3ff,254,63), end-CHS (0x3ff,254,63), startsector 1, 3586051 sectors, extended partition table (last)
|
||||
```
|
||||
|
||||
It's a file system... *Interesting...*
|
||||
|
||||
Using `fdisk`, we can discover that the file system in question is
|
||||
[APFS](https://en.wikipedia.org/wiki/Apple_File_System), a proprietary file
|
||||
system from Apple optimized for SSDs and used as the default on MacOS since the
|
||||
Sierra version.
|
||||
|
||||
```shell
|
||||
$ fdisk -l output.dmg
|
||||
Disk output.dmg: 1.71 GiB, 1836058624 bytes, 3586052 sectors
|
||||
Units: sectors of 1 * 512 = 512 bytes
|
||||
Sector size (logical/physical): 512 bytes / 512 bytes
|
||||
I/O size (minimum/optimal): 512 bytes / 512 bytes
|
||||
Disklabel type: gpt
|
||||
Disk identifier: 8ABB68ED-8C96-425B-B615-36926AC40D4C
|
||||
|
||||
Device Start End Sectors Size Type
|
||||
output.dmg1 40 3586015 3585976 1.7G Apple APFS
|
||||
```
|
||||
|
||||
To mount this file system and extract the files, we can use a FUSE driver for
|
||||
APFS: [apfs-fuse](https://github.com/sgan81/apfs-fuse); it can be found in the
|
||||
repositories of your distribution.
|
||||
|
||||
Once installed, we can use it to mount our file system:
|
||||
|
||||
```shell
|
||||
$ mkdir files/
|
||||
$ apfs-fuse output.dmg files/
|
||||
```
|
||||
|
||||
Finally, we can verify that everything has been mounted correctly with:
|
||||
|
||||
```shell
|
||||
$ mount | tail -n 1
|
||||
output.dmg on /home/user/files type fuse (ro,nosuid,nodev,relatime,user_id=1000,group_id=1000)
|
||||
$ ls files/
|
||||
private-dir root
|
||||
```
|
||||
|
||||
## *Post-scriptum*
|
||||
|
||||
After writing the entire article, I tried out of curiosity to mount the
|
||||
encrypted archive directly with `apfs-fuse`, and it worked.
|
||||
|
||||
So if you know that the content of the DMG is an APFS file system, you can
|
||||
directly use `apfs-fuse` without going through `dmgwiz`.
|
||||
|
||||
## Conclusion
|
||||
|
||||
I decided to write this post because, as already stated by
|
||||
[talebyanis](https://talebyanis.github.io/), opening an encrypted DMG on
|
||||
something other than MacOS is complicated (not hard, **complicated**).
|
||||
|
||||
I hope I have been helpful to the very few people who are facing the same
|
||||
problem as me.
|
After Width: | Height: | Size: 1.9 MiB |
After Width: | Height: | Size: 496 KiB |
After Width: | Height: | Size: 41 KiB |
@ -0,0 +1,554 @@
|
||||
+++
|
||||
title = "Re-implementare un protocollo in Rust"
|
||||
summary = "Step 3: creare una libreria basata sul reverse engineering"
|
||||
date = "2024-08-01"
|
||||
|
||||
tags = ["Libreria", "Lettore di presenze", "TCP", "Rust"]
|
||||
categories = ["Progetti"]
|
||||
series = ["Lettore di presenze"]
|
||||
series_order = 3
|
||||
+++
|
||||
|
||||
Nell'articolo precedente siamo riusciti a comprendere il significato dei
|
||||
pacchetti che vengono scambiati fra il client ufficiale ed il lettore di
|
||||
presenze.
|
||||
|
||||
Rimane solo una cosa da fare: **Riscrivere l'API in Rust!**
|
||||
|
||||

|
||||
|
||||
## Ricreare l'API ufficiale
|
||||
|
||||
Per iniziare [installiamo Rust](https://rust-lang.org/tools/install/) e creiamo
|
||||
un nuovo progetto tramite Cargo, il *package manager* di Rust, con il seguente
|
||||
comando:
|
||||
|
||||
```shell
|
||||
cargo new r701
|
||||
```
|
||||
|
||||
Possiamo poi aprire il progetto col nostro [text editor di
|
||||
fiducia](https://neovim.io/).
|
||||
|
||||
Dato che dobbiamo creare una libreria, andiamo a creare il file `src/lib.rs` e
|
||||
cominciamo a scrivere la struct che descriverà il nostro lettore:
|
||||
|
||||
```rust
|
||||
// src/lib.rs
|
||||
use std::io::Result;
|
||||
use std::net::{TcpStream, ToSocketAddrs};
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct R701 {
|
||||
tcp_stream: TcpStream,
|
||||
sequence_number: u16,
|
||||
}
|
||||
|
||||
impl R701 {
|
||||
pub fn connect(connection_info: impl ToSocketAddrs) -> Result<Self> {
|
||||
// Create a new R701 struct
|
||||
let mut new = Self {
|
||||
tcp_stream: TcpStream::connect(connection_info)?,
|
||||
sequence_number: 0,
|
||||
};
|
||||
|
||||
// Try to ping the endpoint
|
||||
new.ping()?;
|
||||
Ok(new)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
La nostra struct contiene due campi:
|
||||
|
||||
* `tcp_stream`, che contiene il descrittore della connessione al nostro
|
||||
lettore;
|
||||
* `sequence_number`, che memorizza il numero dell'ultimo pacchetto inviato.
|
||||
|
||||
Per provare se la nostra struct si connette correttamente possiamo modificare
|
||||
il file `src/main.rs` in modo che si connetta al nostro endpoint:
|
||||
|
||||
```rust
|
||||
// src/main.rs
|
||||
use r701::R701;
|
||||
|
||||
fn main() {
|
||||
let r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
println!("{:?}", r701);
|
||||
}
|
||||
```
|
||||
|
||||
Se adesso eseguiamo `cargo run`...
|
||||
|
||||

|
||||
|
||||
**Urrà!** Il nostro client si connette con successo al server TCP!
|
||||
|
||||
Il prossimo step sarà quello di utilizzare la libreria
|
||||
[std::net::TcpStream](https://doc.rust-lang.org/std/net/struct.TcpStream.html)
|
||||
per andare ad eseguire le query che abbiamo ricavato dal nostro tentativo di
|
||||
[reverse
|
||||
engineering](/it/posts/2024/05/studying-a-communication-protocol)
|
||||
e ottenere ed elaborare le risposte.
|
||||
|
||||
Dato che [tutte le richieste hanno una struttura
|
||||
standard](/it/posts/2024/05/studying-a-communication-protocol#richieste),
|
||||
possiamo andare a creare un metodo che prende in input il payload di una
|
||||
richiesta (rappresentata da una slice di 12 `u8`) e ritorni un `Vec<u8>`
|
||||
contenente la risposta:
|
||||
|
||||
```rust { hl_lines=["6-23"] }
|
||||
// src/lib.rs
|
||||
|
||||
impl R701 {
|
||||
// ...
|
||||
|
||||
pub fn request(&mut self, payload: &[u8; 12]) -> Result<Vec<u8>> {
|
||||
// Create a blank request
|
||||
let mut request = [0x55, 0xaa, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
|
||||
|
||||
// Insert the payload
|
||||
request[2..14].clone_from_slice(payload);
|
||||
|
||||
// Insert the sequence number
|
||||
request[14..].clone_from_slice(&self.sequence_number.to_le_bytes());
|
||||
self.sequence_number += 1;
|
||||
|
||||
// Send the request
|
||||
self.tcp_stream.write_all(&request)?;
|
||||
|
||||
// Create a buffer and return the response
|
||||
let mut buffer = BufReader::new(&self.tcp_stream);
|
||||
Ok(buffer.fill_buf()?.to_vec())
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Possiamo verificare che tutto funzioni correttamente inviando un [pacchetto di
|
||||
ping](/it/posts/2024/05/studying-a-communication-protocol#ping) e aspettandoci
|
||||
la risposta corretta:
|
||||
|
||||
```rust { hl_lines=["7-10"] }
|
||||
// src/main.rs
|
||||
use r701::R701;
|
||||
|
||||
fn main() {
|
||||
let r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
|
||||
assert_eq!(
|
||||
r701.request(&[0x01, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
|
||||
[0xaa, 0x55, 0x01, 0x01, 0, 0, 0, 0, 0, 0],
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
Potremmo addirittura rendere il ping un metodo a se stante nella nostra struct:
|
||||
|
||||
```rust { hl_lines=["6-16"] }
|
||||
// src/lib.rs
|
||||
|
||||
impl R701 {
|
||||
// ...
|
||||
|
||||
pub fn ping(&mut self) -> Result<()> {
|
||||
// Create a request with a payload of `01 80 00 00 00 00 00 00 00 00 00 00`
|
||||
let response = self.request(&[0x01, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0])?;
|
||||
|
||||
// If the response is not `aa 55 01 01 00 00 00 00 00 00` then return an error
|
||||
if response != [0xaa, 0x55, 0x01, 0x01, 0, 0, 0, 0, 0, 0] {
|
||||
return Err(Error::new(InvalidData, "Malformed response"));
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Con questo metodo possiamo andare a creare anche i metodi per ottenere il [nome
|
||||
di un
|
||||
dipendente](/it/posts/2024/05/studying-a-communication-protocol#nome-del-dipendente),
|
||||
il [numero totale di
|
||||
presenze](/it/posts/2024/05/studying-a-communication-protocol#numero-totale-di-presenze)
|
||||
ed un [blocco di
|
||||
presenze](/it/posts/2024/05/studying-a-communication-protocol#scaricamento-di-tutte-le-presenze).
|
||||
|
||||
Se siete interessati, tutto il codice sorgente è già presente su
|
||||
[nicolabelluti/r701](https://git.nicolabelluti.me/nicolabelluti/r701/src/branch/main/src/r701.rs).
|
||||
|
||||
{{< gitea server="https://git.nicolabelluti.me" repo="nicolabelluti/r701" >}}
|
||||
|
||||
## Estrarre le presenze tramite il trait TryInto
|
||||
|
||||
Una volta creato il metodo che ci permette di estrarre un blocco di presenze,
|
||||
bisogna trovare il modo idiomatico per trasformarlo da un array di byte a una
|
||||
struct che rappresenti una singola presenza.
|
||||
|
||||
Per iniziare facciamo un po' di *refactoring* rinominando `src/lib.rs` in
|
||||
`src/r701.rs` e creando un nuovo `src/lib.rs` contenente queste righe:
|
||||
|
||||
```rust
|
||||
// src/lib.rs
|
||||
mod r701;
|
||||
pub use r701::R701;
|
||||
```
|
||||
|
||||
In questo modo l'interfaccia esterna della nostra libreria non cambierà, però
|
||||
così facendo possiamo organizzare il nostro codice in diversi file.
|
||||
|
||||
Aggiungiamo il file `src/record.rs` e includiamolo in `src/lib.rs`
|
||||
|
||||
```rust { hl_lines=[3,6] }
|
||||
// src/lib.rs
|
||||
mod r701;
|
||||
mod record;
|
||||
|
||||
pub use r701::R701;
|
||||
pub use record::{Record, Clock};
|
||||
```
|
||||
|
||||
```rust
|
||||
// src/record.rs
|
||||
use chrono::{DateTime, Local, TimeZone};
|
||||
|
||||
pub enum Clock {
|
||||
FirstIn,
|
||||
FirstOut,
|
||||
SecondIn,
|
||||
SecondOut,
|
||||
}
|
||||
|
||||
pub struct Record {
|
||||
pub employee_id: u32,
|
||||
pub clock: Clock,
|
||||
pub datetime: DateTime<Local>,
|
||||
}
|
||||
```
|
||||
|
||||
Con questo codice abbiamo definito la struttura di una presenza che, come
|
||||
abbiamo detto nell'articolo precedente, è composta dall'ID del dipendente,
|
||||
dalla data e dall'ora alla quale è stata registrata e dallo stato (se è la
|
||||
prima entrata, la prima uscita, la seconda entrata o la seconda uscita).
|
||||
|
||||
Dato che [non vogliamo impazzire gestendo il
|
||||
tempo](https://www.youtube.com/watch?v=-5wpm-gesOY), andiamo ad importare il
|
||||
*crate* [chrono](https://crates.io/crates/chrono/) per la gestione delle date:
|
||||
|
||||
```shell
|
||||
cargo add chrono --no-default-features --features clock
|
||||
```
|
||||
|
||||
Per facilitare la conversione da un vettore di byte alla nostra struct `Record`
|
||||
possiamo implementare il trait
|
||||
[TryInto](https://doc.rust-lang.org/std/convert/trait.TryInto.html):
|
||||
|
||||
```rust
|
||||
// src/record.rs
|
||||
impl TryFrom<&[u8]> for Record {
|
||||
type Error = &'static str;
|
||||
|
||||
fn try_from(record_bytes: &[u8]) -> Result<Self, Self::Error> {
|
||||
// ...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Il codice finito è disponibile
|
||||
[qua](https://git.nicolabelluti.me/nicolabelluti/r701/src/branch/main/src/record.rs#L32).
|
||||
|
||||
Possiamo testare se la conversione è corretta tramite un semplice test:
|
||||
|
||||
```rust
|
||||
// src/record.rs
|
||||
|
||||
// ...
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn valid_record_conversion() {
|
||||
let record_bytes: &[u8] = &[0x10, 0x23, 0x0b, 0x1d, 0x01, 0, 0, 0, 0xb2, 0x17, 0x01, 0];
|
||||
|
||||
assert_eq!(
|
||||
record_bytes.try_into(),
|
||||
Ok(Record {
|
||||
employee_id: 1,
|
||||
clock: Clock::FirstIn,
|
||||
datetime: Local.with_ymd_and_hms(1970, 1, 1, 0, 0, 0).single().unwrap(),
|
||||
})
|
||||
)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Unire il tutto tramite gli iteratori
|
||||
|
||||
Una volta trovato un modo per estrarre dei byte dal dispositivo ed un modo per
|
||||
convertirli in una struct, dobbiamo trovare il modo idiomatico per mettere
|
||||
insieme le due cose, ed è proprio qua che entrano in gioco gli iteratori.
|
||||
|
||||
Per implemetare il trait
|
||||
[Iterator](https://doc.rust-lang.org/std/iter/trait.Iterator.html) bisogna
|
||||
definire solo il metodo `next()` che, partendo dal primo elemento, ritorna
|
||||
l'elemento successivo.
|
||||
|
||||
Una volta definito questo metodo avremmo accesso a molti altri strumenti, come
|
||||
[map()](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.map),
|
||||
[filter()](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.filter),
|
||||
[fold()](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.fold) e,
|
||||
se andiamo ad importare il *crate*
|
||||
[itertools](https://crates.io/crates/itertools), anche
|
||||
[sorted()](https://docs.rs/itertools/0.12.1/itertools/trait.Itertools.html#method.sorted)
|
||||
e
|
||||
[into_group_map_by()](https://docs.rs/itertools/0.12.1/itertools/trait.Itertools.html#method.into_group_map_by),
|
||||
giusto per elencarne alcuni.
|
||||
|
||||
Come prima cosa andiamo a creare una nuova struct `RecordIterator` con un
|
||||
costruttore `from()` che ci permetta di generare un iteratore prendendo in
|
||||
input una *reference* mutabile ad una struct `R701`:
|
||||
|
||||
```rust { hl_lines=[4,8] }
|
||||
// src/lib.rs
|
||||
mod r701;
|
||||
mod record;
|
||||
mod record_iterator;
|
||||
|
||||
pub use r701::R701;
|
||||
pub use record::{Record, Clock};
|
||||
pub use record_iterator::RecordIterator;
|
||||
```
|
||||
|
||||
```rust
|
||||
// src/record_iterator.rs
|
||||
use crate::R701;
|
||||
use std::io::Result;
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct RecordIterator<'a> {
|
||||
r701: &'a mut R701,
|
||||
input_buffer: Vec<u8>,
|
||||
sequence_number: u16,
|
||||
total_records: u16,
|
||||
record_count: u16,
|
||||
}
|
||||
|
||||
impl<'a> RecordIterator<'a> {
|
||||
pub fn from(r701: &'a mut R701) -> Result<Self> {
|
||||
// ...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Il metodo `from()` richiede al lettore il numero totale di timbrate ed il primo
|
||||
blocco di presenze , salvandoli rispettivamente nella variabile `total_records`
|
||||
e nel vettore `input_buffer`.
|
||||
|
||||
Il metodo `next()` del trait `Iterator` andrà poi a prendere i primi 12 byte
|
||||
dell'`input buffer` e li trasformerà in una struct `Record` tramite il trait
|
||||
`TryInto` che abbiamo implementato nel capitolo precedente.
|
||||
|
||||
Quando `input_buffer` è vuoto allora viene richiesto al lettore un'altro blocco
|
||||
di presenze, fino a che non vengono lette tutte.
|
||||
|
||||
Se siete interessati tutto il codice è già [disponibile su
|
||||
Git](https://git.nicolabelluti.me/nicolabelluti/r701/src/branch/main/src/record_iterator.rs).
|
||||
|
||||
```rust
|
||||
// src/record_iterator.rs
|
||||
|
||||
// ...
|
||||
|
||||
impl<'a> Iterator for RecordIterator<'a> {
|
||||
type Item = Record;
|
||||
|
||||
fn next(&mut self) -> Option<Self::Item> {
|
||||
// ...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Giusto per completezza possiamo implementare un metodo `into_record_iter` nella
|
||||
struct `R701`, per semplificare l'utilizzo dell'iteratore:
|
||||
|
||||
```rust { hl_lines=[2,"9-11"] }
|
||||
// src/r701.rs
|
||||
use crate::RecordIterator;
|
||||
|
||||
// ...
|
||||
|
||||
impl R701 {
|
||||
// ...
|
||||
|
||||
pub fn into_record_iter(&mut self) -> Result<RecordIterator> {
|
||||
RecordIterator::from(self)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Rendere il tutto *Blazingly Fast*
|
||||
|
||||
Come prima cosa andiamo a creare un main che crei un file con la stessa
|
||||
struttura del file `AGLog_001.txt` che abbiamo visto nel [primo
|
||||
capitolo](/it/posts/2024/04/reverse-engineering-an-attendance-reader/#dump-delle-registrazioni-tramite-usb)
|
||||
di questa serie:
|
||||
|
||||
```rust
|
||||
// src/main.rs
|
||||
use r701::R701;
|
||||
|
||||
fn main() {
|
||||
let mut r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
|
||||
println!("No\tMchn\tEnNo\t\tName\t\tMode\tIOMd\tDateTime\t");
|
||||
r701.into_record_iter()
|
||||
.unwrap()
|
||||
.collect::<Vec<_>>()
|
||||
.iter()
|
||||
.enumerate()
|
||||
.for_each(|(id, record)| {
|
||||
let name = r701
|
||||
.get_name(record.employee_id)
|
||||
.unwrap()
|
||||
.unwrap_or(format!("user #{}", record.employee_id));
|
||||
|
||||
println!(
|
||||
"{:0>6}\t{}\t{:0>9}\t{: <10}\t{}\t{}\t{}",
|
||||
id + 1,
|
||||
1,
|
||||
record.employee_id,
|
||||
name,
|
||||
35,
|
||||
record.clock as u8,
|
||||
record.datetime.format("%Y/%m/%d %H:%M:%S"),
|
||||
);
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
Già con questo `main()` riusciamo ad ottenere tutti i record in un po' meno di
|
||||
un minuto, che è la metà del tempo che impiega il [client closed source
|
||||
ufficiale](/it/posts/2024/05/studying-a-communication-protocol/#configurazione-del-client).
|
||||
|
||||
Certo, stiamo leggermente barando dato che il nostro client non riesce ad
|
||||
estrarre l'ID del registratore, la modalità di registrazione della presenza ed
|
||||
i secondi del campo `DateTime`, ma per il momento possiamo ignorarli dato che
|
||||
sono campi superflui.
|
||||
|
||||
### Memoizzare il nome dei dipendenti
|
||||
|
||||
Per velocizzare ancora di più le cose potremmo evitare di chiedere al tibratore
|
||||
il nome dei dipendente per ogni record.
|
||||
|
||||
Possiamo creare un `HashMap` di nomi e, per ogni record, verificare se il nome
|
||||
è già presente al suo interno. Se no, allora si può chiedere al timbratore il
|
||||
nome del dipendente per poi salvarlo all'interno dell `HashMap`.
|
||||
|
||||
In questo modo andiamo a ridurre il numero di richieste al minimo
|
||||
indispensabile.
|
||||
|
||||
```rust { hl_lines=[3,6,"16-20"] }
|
||||
// src/main.rs
|
||||
use r701::R701;
|
||||
use std::collections::HashMap;
|
||||
|
||||
fn main() {
|
||||
let mut names = HashMap::new();
|
||||
let mut r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
|
||||
println!("No\tMchn\tEnNo\t\tName\t\tMode\tIOMd\tDateTime\t");
|
||||
r701.into_record_iter()
|
||||
.unwrap()
|
||||
.collect::<Vec<_>>()
|
||||
.iter()
|
||||
.enumerate()
|
||||
.for_each(|(id, record)| {
|
||||
let name = names.entry(record.employee_id).or_insert_with(|| {
|
||||
r701.get_name(record.employee_id)
|
||||
.unwrap()
|
||||
.unwrap_or(format!("user #{}", record.employee_id))
|
||||
});
|
||||
|
||||
// ...
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
Con questa semplice modifica passiamo da ottenere tutti i record in un minuto
|
||||
ad ottenerli in **un secondo**. Questo sì che è *blazingly fast*!
|
||||
|
||||
### Limitare la lettura delle presenze ad un certo arco temporale
|
||||
|
||||
Dato che mi interessano i dati dell'ultimo mese, possiamo utilizzare i metodi
|
||||
[take_while()](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.take_while)
|
||||
e
|
||||
[skip_while()](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.skip_while)
|
||||
per escludere tutti gli elementi precedenti allo scorso mese e per fermare
|
||||
l'iteratore una volta estratti tutti i record interessati:
|
||||
|
||||
```rust { hl_lines=[4,"7-8","16-17"] }
|
||||
// src/main.rs
|
||||
use r701::R701;
|
||||
use std::collections::HashMap;
|
||||
use chrono::{Local, TimeZone};
|
||||
|
||||
fn main() {
|
||||
let start = Local.with_ymd_and_hms(2024, 7, 1, 0, 0, 0).unwrap();
|
||||
let end = Local.with_ymd_and_hms(2024, 8, 1, 0, 0, 0).unwrap();
|
||||
let mut names = HashMap::new();
|
||||
|
||||
let mut r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
|
||||
println!("No\tMchn\tEnNo\t\tName\t\tMode\tIOMd\tDateTime\t");
|
||||
r701.into_record_iter()
|
||||
.unwrap()
|
||||
.take_while(|record| record.datetime < end)
|
||||
.skip_while(|record| record.datetime < start)
|
||||
.collect::<Vec<_>>()
|
||||
.iter()
|
||||
.enumerate()
|
||||
.for_each(|(id, record)| {
|
||||
// ...
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
Questa modifica non migliora in alcun modo le performance, ma c'è un ultima
|
||||
miglioria molto semplice che possiamo applicare per questo specifico caso
|
||||
d'uso...
|
||||
|
||||
### Leggere le presenze al contrario
|
||||
|
||||
Al posto di iniziare dal primo record mai registrato ed escludere tutti i
|
||||
record fino ad arrivare al primo del mese interessato potremmo leggere i record
|
||||
al contrario, partendo da quello più recente ed andando verso a quello più
|
||||
datato.
|
||||
|
||||
Questa miglioria richiede [un po' di
|
||||
modifiche](https://git.nicolabelluti.me/nicolabelluti/r701/compare/f0ac5fe7..0dd05c0d#diff-44adb0ed617220e3fd4a4bbb2e361059ac47d9c4),
|
||||
ma ne vale la pena considerando che ci fa passare da un po' meno di un secondo
|
||||
a **0,2 secondi**!
|
||||
|
||||
```rust { hl_lines=["11-12",15] }
|
||||
// src/main.rs
|
||||
|
||||
// ...
|
||||
|
||||
fn main() {
|
||||
// ...
|
||||
|
||||
println!("No\tMchn\tEnNo\t\tName\t\tMode\tIOMd\tDateTime\t");
|
||||
r701.into_record_iter()
|
||||
.unwrap()
|
||||
.take_while(|record| record.datetime >= start)
|
||||
.skip_while(|record| record.datetime >= end)
|
||||
.collect::<Vec<_>>()
|
||||
.iter()
|
||||
.rev()
|
||||
.enumerate()
|
||||
.for_each(|(id, record)| {
|
||||
// ...
|
||||
});
|
||||
}
|
||||
``
|
@ -0,0 +1,545 @@
|
||||
+++
|
||||
title = "Re-implementing a protocol in Rust"
|
||||
summary = "Setp 3: Creating a library based on reverse engineering"
|
||||
date = "2024-08-01"
|
||||
|
||||
tags = ["Library", "Attendance Reader", "TCP", "Rust"]
|
||||
categories = ["Projects"]
|
||||
series = ["Attendance Reader"]
|
||||
series_order = 3
|
||||
+++
|
||||
|
||||
In the previous article, we managed to understand the meaning of the packets
|
||||
exchanged between the official client and the attendance reader.
|
||||
|
||||
There is only one thing left to do: **Rewrite the API in Rust!**
|
||||
|
||||

|
||||
|
||||
## Recreating the Official API
|
||||
|
||||
To start, let's [install Rust](https://rust-lang.org/tools/install/) and create
|
||||
a new project using Cargo, Rust's package manager, using the following command:
|
||||
|
||||
```shell
|
||||
cargo new r701
|
||||
```
|
||||
|
||||
We can then open the project with our [text editor of
|
||||
choice](https://neovim.io/).
|
||||
|
||||
Since we need to create a library, let's create the file `src/lib.rs` and start
|
||||
writing the struct that will describe our reader:
|
||||
|
||||
```rust
|
||||
// src/lib.rs
|
||||
use std::io::Result;
|
||||
use std::net::{TcpStream, ToSocketAddrs};
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct R701 {
|
||||
tcp_stream: TcpStream,
|
||||
sequence_number: u16,
|
||||
}
|
||||
|
||||
impl R701 {
|
||||
pub fn connect(connection_info: impl ToSocketAddrs) -> Result<Self> {
|
||||
// Create a new R701 struct
|
||||
let mut new = Self {
|
||||
tcp_stream: TcpStream::connect(connection_info)?,
|
||||
sequence_number: 0,
|
||||
};
|
||||
|
||||
// Try to ping the endpoint
|
||||
new.ping()?;
|
||||
Ok(new)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Our struct contains two fields:
|
||||
|
||||
* `tcp_stream`, which contains the descriptor of the connection to our reader;
|
||||
* `sequence_number`, which stores the number of the last packet sent.
|
||||
|
||||
To test if our struct connects correctly, we can modify the file `src/main.rs`
|
||||
so that it connects to our endpoint:
|
||||
|
||||
```rust
|
||||
// src/main.rs
|
||||
use r701::R701;
|
||||
|
||||
fn main() {
|
||||
let r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
println!("{:?}", r701);
|
||||
}
|
||||
```
|
||||
|
||||
If we now run `cargo run`...
|
||||
|
||||

|
||||
|
||||
**Hurray!** Our client successfully connects to the TCP server!
|
||||
|
||||
The next step will be to use the library
|
||||
[std::net::TcpStream](https://doc.rust-lang.org/std/net/struct.TcpStream.html)
|
||||
to execute the queries we derived from our attempt at [reverse
|
||||
engineering](/posts/2024/05/studying-a-communication-protocol) and obtain and
|
||||
process the responses.
|
||||
|
||||
Since [all requests have a standard
|
||||
structure](/posts/2024/05/studying-a-communication-protocol#requests), we can
|
||||
create a method that takes as input the payload of a request (represented by a
|
||||
slice of 12 `u8`) and returns a `Vec<u8>` containing the response:
|
||||
|
||||
```rust { hl_lines=["6-23"] }
|
||||
// src/lib.rs
|
||||
|
||||
impl R701 {
|
||||
// ...
|
||||
|
||||
pub fn request(&mut self, payload: &[u8; 12]) -> Result<Vec<u8>> {
|
||||
// Create a blank request
|
||||
let mut request = [0x55, 0xaa, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
|
||||
|
||||
// Insert the payload
|
||||
request[2..14].clone_from_slice(payload);
|
||||
|
||||
// Insert the sequence number
|
||||
request[14..].clone_from_slice(&self.sequence_number.to_le_bytes());
|
||||
self.sequence_number += 1;
|
||||
|
||||
// Send the request
|
||||
self.tcp_stream.write_all(&request)?;
|
||||
|
||||
// Create a buffer and return the response
|
||||
let mut buffer = BufReader::new(&self.tcp_stream);
|
||||
Ok(buffer.fill_buf()?.to_vec())
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
We can verify that everything works correctly by sending a [ping
|
||||
packet](/posts/2024/05/studying-a-communication-protocol#ping)
|
||||
and expecting the correct response:
|
||||
|
||||
```rust { hl_lines=["7-10"] }
|
||||
// src/main.rs
|
||||
use r701::R701;
|
||||
|
||||
fn main() {
|
||||
let r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
|
||||
assert_eq!(
|
||||
r701.request(&[0x01, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
|
||||
[0xaa, 0x55, 0x01, 0x01, 0, 0, 0, 0, 0, 0],
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
We could even make ping a method in our struct:
|
||||
|
||||
```rust { hl_lines=["6-16"] }
|
||||
// src/lib.rs
|
||||
|
||||
impl R701 {
|
||||
// ...
|
||||
|
||||
pub fn ping(&mut self) -> Result<()> {
|
||||
// Create a request with a payload of `01 80 00 00 00 00 00 00 00 00 00 00`
|
||||
let response = self.request(&[0x01, 0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0])?;
|
||||
|
||||
// If the response is not `aa 55 01 01 00 00 00 00 00 00` then return an error
|
||||
if response != [0xaa, 0x55, 0x01, 0x01, 0, 0, 0, 0, 0, 0] {
|
||||
return Err(Error::new(InvalidData, "Malformed response"));
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
In this way we can also create methods to obtain the [name of an
|
||||
employee](/posts/2024/05/studying-a-communication-protocol#employee-name), the
|
||||
[total number of
|
||||
records](/posts/2024/05/studying-a-communication-protocol#total-number-of-records),
|
||||
and a [block of
|
||||
records](/posts/2024/05/studying-a-communication-protocol#downloading-all-records).
|
||||
|
||||
If you are interested, all the source code is already available at
|
||||
[nicolabelluti/r701](https://git.nicolabelluti.me/nicolabelluti/r701/src/branch/main/src/r701.rs).
|
||||
|
||||
{{< gitea server="https://git.nicolabelluti.me" repo="nicolabelluti/r701" >}}
|
||||
|
||||
## Extracting Attendances via the TryInto Trait
|
||||
|
||||
Once we have created the method that allows us to extract a block of
|
||||
attendances, we need to find the idiomatic way to transform it from an array of
|
||||
bytes to a struct that represents a single attendance.
|
||||
|
||||
To start, let's do some *refactoring* by renaming `src/lib.rs` to `src/r701.rs`
|
||||
and creating a new `src/lib.rs` containing these lines:
|
||||
|
||||
```rust
|
||||
// src/lib.rs
|
||||
mod r701;
|
||||
pub use r701::R701;
|
||||
```
|
||||
|
||||
This way, the external interface of our library will not change, but we can
|
||||
organize our code into different files.
|
||||
|
||||
Let's add the file `src/record.rs` and include it in `src/lib.rs`
|
||||
|
||||
```rust { hl_lines=[3,6] }
|
||||
// src/lib.rs
|
||||
mod r701;
|
||||
mod record;
|
||||
|
||||
pub use r701::R701;
|
||||
pub use record::{Record, Clock};
|
||||
```
|
||||
|
||||
```rust
|
||||
// src/record.rs
|
||||
use chrono::{DateTime, Local, TimeZone};
|
||||
|
||||
pub enum Clock {
|
||||
FirstIn,
|
||||
FirstOut,
|
||||
SecondIn,
|
||||
SecondOut,
|
||||
}
|
||||
|
||||
pub struct Record {
|
||||
pub employee_id: u32,
|
||||
pub clock: Clock,
|
||||
pub datetime: DateTime<Local>,
|
||||
}
|
||||
```
|
||||
|
||||
With this code, we have defined the structure of a record, which, as we
|
||||
mentioned in the previous article, consists of the employee ID, the date and
|
||||
time it was recorded, and the state (whether it is the first entry, the first
|
||||
exit, the second entry, or the second exit).
|
||||
|
||||
Since we don't want to [go crazy managing
|
||||
time](https://www.youtube.com/watch?v=-5wpm-gesOY), let's import the
|
||||
[chrono](https://crates.io/crates/chrono/) *crate* for date management:
|
||||
|
||||
```shell
|
||||
cargo add chrono --no-default-features --features clock
|
||||
```
|
||||
|
||||
To facilitate the conversion from a byte vector to our `Record` struct, we can
|
||||
implement the
|
||||
[TryInto](https://doc.rust-lang.org/std/convert/trait.TryInto.html) trait:
|
||||
|
||||
```rust
|
||||
// src/record.rs
|
||||
impl TryFrom<&[u8]> for Record {
|
||||
type Error = &'static str;
|
||||
|
||||
fn try_from(record_bytes: &[u8]) -> Result<Self, Self::Error> {
|
||||
// ...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The finished code is available
|
||||
[here](https://git.nicolabelluti.me/nicolabelluti/r701/src/branch/main/src/record.rs#L32).
|
||||
|
||||
We can test if the conversion is correct through a simple test:
|
||||
|
||||
```rust
|
||||
// src/record.rs
|
||||
|
||||
// ...
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn valid_record_conversion() {
|
||||
let record_bytes: &[u8] = &[0x10, 0x23, 0x0b, 0x1d, 0x01, 0, 0, 0, 0xb2, 0x17, 0x01, 0];
|
||||
|
||||
assert_eq!(
|
||||
record_bytes.try_into(),
|
||||
Ok(Record {
|
||||
employee_id: 1,
|
||||
clock: Clock::FirstIn,
|
||||
datetime: Local.with_ymd_and_hms(1970, 1, 1, 0, 0, 0).single().unwrap(),
|
||||
})
|
||||
)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Putting It All Together with Iterators
|
||||
|
||||
Once we have found a way to extract bytes from the device and a way to convert
|
||||
them into a struct, we need to find the idiomatic way to combine the two, and
|
||||
this is where iterators come into play.
|
||||
|
||||
To implement the
|
||||
[Iterator](https://doc.rust-lang.org/std/iter/trait.Iterator.html) trait, we
|
||||
only need to define the `next()` method, which, starting from the first
|
||||
element, returns the next element.
|
||||
|
||||
Once this method is defined, we will have access to many other tools, such as
|
||||
[map()](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.map),
|
||||
[filter()](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.filter),
|
||||
[fold()](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.fold),
|
||||
and, if we import the [itertools](https://crates.io/crates/itertools) *crate*,
|
||||
also
|
||||
[sorted()](https://docs.rs/itertools/0.12.1/itertools/trait.Itertools.html#method.sorted)
|
||||
and
|
||||
[into_group_map_by()](https://docs.rs/itertools/0.12.1/itertools/trait.Itertools.html#method.into_group_map_by),
|
||||
just to name a few.
|
||||
|
||||
First, let's create a new struct `RecordIterator` with a `from()` constructor
|
||||
that allows us to generate an iterator by taking a mutable reference to an
|
||||
`R701` struct as input:
|
||||
|
||||
```rust { hl_lines=[4,8] }
|
||||
// src/lib.rs
|
||||
mod r701;
|
||||
mod record;
|
||||
mod record_iterator;
|
||||
|
||||
pub use r701::R701;
|
||||
pub use record::{Record, Clock};
|
||||
pub use record_iterator::RecordIterator;
|
||||
```
|
||||
|
||||
```rust
|
||||
// src/record_iterator.rs
|
||||
use crate::R701;
|
||||
use std::io::Result;
|
||||
|
||||
#[derive(Debug)]
|
||||
pub struct RecordIterator<'a> {
|
||||
r701: &'a mut R701,
|
||||
input_buffer: Vec<u8>,
|
||||
sequence_number: u16,
|
||||
total_records: u16,
|
||||
record_count: u16,
|
||||
}
|
||||
|
||||
impl<'a> RecordIterator<'a> {
|
||||
pub fn from(r701: &'a mut R701) -> Result<Self> {
|
||||
// ...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The `from()` method requires the reader to provide the total number of
|
||||
timestamps and the first block of attendances, saving them respectively in the
|
||||
`total_records` variable and the `input_buffer` vector.
|
||||
|
||||
The `next()` method of the `Iterator` trait will then take the first 12 bytes
|
||||
from the `input_buffer` and transform them into a `Record` struct using the
|
||||
`TryInto` trait that we implemented in the previous chapter.
|
||||
|
||||
When the `input_buffer` is empty, the reader is requested for another block of
|
||||
attendances until all are read.
|
||||
|
||||
If you are interested, all the code is already [available on
|
||||
Git](https://git.nicolabelluti.me/nicolabelluti/r701/src/branch/main/src/record_iterator.rs).
|
||||
|
||||
```rust
|
||||
// src/record_iterator.rs
|
||||
|
||||
// ...
|
||||
|
||||
impl<'a> Iterator for RecordIterator<'a> {
|
||||
type Item = Record;
|
||||
|
||||
fn next(&mut self) -> Option<Self::Item> {
|
||||
// ...
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Just for completeness, we can implement an `into_record_iter` method in the
|
||||
`R701` struct to simplify the use of the iterator:
|
||||
|
||||
```rust { hl_lines=[2,"9-11"] }
|
||||
// src/r701.rs
|
||||
use crate::RecordIterator;
|
||||
|
||||
// ...
|
||||
|
||||
impl R701 {
|
||||
// ...
|
||||
|
||||
pub fn into_record_iter(&mut self) -> Result<RecordIterator> {
|
||||
RecordIterator::from(self)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Making Everything *Blazingly Fast*
|
||||
|
||||
First, let's create a main that creates a file with the same structure as the
|
||||
`AGLog_001.txt` file we saw in the [first
|
||||
chapter](/posts/2024/04/reverse-engineering-an-attendance-reader/#dumping-the-records-via-usb)
|
||||
of this series:
|
||||
|
||||
```rust
|
||||
// src/main.rs
|
||||
use r701::R701;
|
||||
|
||||
fn main() {
|
||||
let mut r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
|
||||
println!("No\tMchn\tEnNo\t\tName\t\tMode\tIOMd\tDateTime\t");
|
||||
r701.into_record_iter()
|
||||
.unwrap()
|
||||
.collect::<Vec<_>>()
|
||||
.iter()
|
||||
.enumerate()
|
||||
.for_each(|(id, record)| {
|
||||
let name = r701
|
||||
.get_name(record.employee_id)
|
||||
.unwrap()
|
||||
.unwrap_or(format!("user #{}", record.employee_id));
|
||||
|
||||
println!(
|
||||
"{:0>6}\t{}\t{:0>9}\t{: <10}\t{}\t{}\t{}",
|
||||
id + 1,
|
||||
1,
|
||||
record.employee_id,
|
||||
name,
|
||||
35,
|
||||
record.clock as u8,
|
||||
record.datetime.format("%Y/%m/%d %H:%M:%S"),
|
||||
);
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
With this `main()`, we can obtain all the records in just under a minute, which
|
||||
is half the time taken by the [official closed-source
|
||||
client](/posts/2024/05/studying-a-communication-protocol/#client-configuration).
|
||||
|
||||
We are slightly cheating, as our client cannot extract the ID of the recorder,
|
||||
the attendance recording method, and the seconds of the `DateTime` field, but
|
||||
for now we can ignore them as they are superfluous fields.
|
||||
|
||||
### Memoizing Employee Names
|
||||
|
||||
To speed things up even more, we could avoid asking the reader for the name of
|
||||
the employee for each record.
|
||||
|
||||
We can create a `HashMap` of names and, for each record, check if the name is
|
||||
already present in it. If not, we can ask the reader for the employee's name
|
||||
and then save it in the `HashMap`.
|
||||
|
||||
This way, we reduce the number of requests to the minimum required.
|
||||
|
||||
```rust { hl_lines=[3,6,"16-20"] }
|
||||
// src/main.rs
|
||||
use r701::R701;
|
||||
use std::collections::HashMap;
|
||||
|
||||
fn main() {
|
||||
let mut names = HashMap::new();
|
||||
let mut r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
|
||||
println!("No\tMchn\tEnNo\t\tName\t\tMode\tIOMd\tDateTime\t");
|
||||
r701.into_record_iter()
|
||||
.unwrap()
|
||||
.collect::<Vec<_>>()
|
||||
.iter()
|
||||
.enumerate()
|
||||
.for_each(|(id, record)| {
|
||||
let name = names.entry(record.employee_id).or_insert_with(|| {
|
||||
r701.get_name(record.employee_id)
|
||||
.unwrap()
|
||||
.unwrap_or(format!("user #{}", record.employee_id))
|
||||
});
|
||||
|
||||
// ...
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
With this simple modification, we go from obtaining all records in a minute to
|
||||
obtaining them in **one second**. Now that is *blazingly fast*!
|
||||
|
||||
### Limiting Attendance Reading to a Certain Time Frame
|
||||
|
||||
Since I am interested in the data from the last month, we can use the
|
||||
[take_while()](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.take_while)
|
||||
and
|
||||
[skip_while()](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.skip_while)
|
||||
methods to exclude all elements prior to last month and to stop the iterator
|
||||
once all relevant records have been extracted:
|
||||
|
||||
```rust { hl_lines=[4,"7-8","16-17"] }
|
||||
// src/main.rs
|
||||
use r701::R701;
|
||||
use std::collections::HashMap;
|
||||
use chrono::{Local, TimeZone};
|
||||
|
||||
fn main() {
|
||||
let start = Local.with_ymd_and_hms(2024, 7, 1, 0, 0, 0).unwrap();
|
||||
let end = Local.with_ymd_and_hms(2024, 8, 1, 0, 0, 0).unwrap();
|
||||
let mut names = HashMap::new();
|
||||
|
||||
let mut r701 = R701::connect("127.0.0.1:5005").unwrap();
|
||||
|
||||
println!("No\tMchn\tEnNo\t\tName\t\tMode\tIOMd\tDateTime\t");
|
||||
r701.into_record_iter()
|
||||
.unwrap()
|
||||
.take_while(|record| record.datetime < end)
|
||||
.skip_while(|record| record.datetime < start)
|
||||
.collect::<Vec<_>>()
|
||||
.iter()
|
||||
.enumerate()
|
||||
.for_each(|(id, record)| {
|
||||
// ...
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
This modification does not improve performance in any way, but there is one
|
||||
last very simple improvement we can apply for this specific use case...
|
||||
|
||||
### Reading Records in Reverse
|
||||
|
||||
Instead of starting from the first record ever registered and excluding all
|
||||
records until we reach the first of the month we're interested in, we could
|
||||
read the records in reverse, starting from the most recent one and going back
|
||||
to the oldest.
|
||||
|
||||
This improvement requires [a few
|
||||
modifications](https://git.nicolabelluti.me/nicolabelluti/r701/compare/f0ac5fe7..0dd05c0d#diff-44adb0ed617220e3fd4a4bbb2e361059ac47d9c4),
|
||||
but it is worth it considering that it reduces the time from just under a
|
||||
second to **0.2 seconds**!
|
||||
|
||||
```rust { hl_lines=["11-12",15] }
|
||||
// src/main.rs
|
||||
|
||||
// ...
|
||||
|
||||
fn main() {
|
||||
// ...
|
||||
|
||||
println!("No\tMchn\tEnNo\t\tName\t\tMode\tIOMd\tDateTime\t");
|
||||
r701.into_record_iter()
|
||||
.unwrap()
|
||||
.take_while(|record| record.datetime >= start)
|
||||
.skip_while(|record| record.datetime >= end)
|
||||
.collect::<Vec<_>>()
|
||||
.iter()
|
||||
.rev()
|
||||
.enumerate()
|
||||
.for_each(|(id, record)| {
|
||||
// ...
|
||||
});
|
||||
}
|
||||
```
|
After Width: | Height: | Size: 289 KiB |
12
content/posts/todo/installing-linux-on-a-tv-box/index.it.md
Normal file
@ -0,0 +1,12 @@
|
||||
+++
|
||||
title = "Installare Linux su un TV Box"
|
||||
summary = "Come dare una nuova vita ad un TV Box Android"
|
||||
date = "2038-01-19"
|
||||
|
||||
tags = ["TV Box", "Strong", "Leap S1", "Android", "Armbian", "CoreELEC"]
|
||||
categories = ["Robe che ho fatto"]
|
||||
|
||||
draft = true
|
||||
+++
|
||||
|
||||
> Hello, world!
|
12
content/posts/todo/installing-linux-on-a-tv-box/index.md
Normal file
@ -0,0 +1,12 @@
|
||||
+++
|
||||
title = "Installing Linux on a TV Box"
|
||||
summary = "How to repurpose an Android TV box"
|
||||
date = "2038-01-19"
|
||||
|
||||
tags = ["TV Box", "Strong", "Leap S1", "Android", "Armbian", "CoreELEC"]
|
||||
categories = ["Things I've done"]
|
||||
|
||||
draft = true
|
||||
+++
|
||||
|
||||
> Hello, world!
|
After Width: | Height: | Size: 871 KiB |
@ -0,0 +1,12 @@
|
||||
+++
|
||||
title = "Gestire i dotfiles con Chezmoi"
|
||||
summary = "Come rendere la propria home directory portabile"
|
||||
date = "2038-01-19"
|
||||
|
||||
tags = ["Dotfiles", "Linux", "Chezmoi", "Git"]
|
||||
categories = ["Tutorial"]
|
||||
|
||||
draft = true
|
||||
+++
|
||||
|
||||
> Hello, world!
|
12
content/posts/todo/managing-dotfiles-with-chezmoi/index.md
Normal file
@ -0,0 +1,12 @@
|
||||
+++
|
||||
title = "Managing Dotfiles with Chezmoi"
|
||||
summary = "Making your home directory portable"
|
||||
date = "2038-01-19"
|
||||
|
||||
tags = ["Dotfiles", "Linux", "Chezmoi", "Git"]
|
||||
categories = ["Tutorial"]
|
||||
|
||||
draft = true
|
||||
+++
|
||||
|
||||
> Hello, world!
|
After Width: | Height: | Size: 480 KiB |
12
content/posts/todo/virtualizing-a-nas/index.it.md
Normal file
@ -0,0 +1,12 @@
|
||||
+++
|
||||
title = "Virtualizzare un NAS"
|
||||
summary = "Come prendere i dati da un NAS fisico e trasferirli dentro ad un VM"
|
||||
date = "2038-01-19"
|
||||
|
||||
tags = ["NAS", "VM", "BTRFS", "Compressione", "Copy-on-write"]
|
||||
categories = ["Robe che ho fatto"]
|
||||
|
||||
draft = true
|
||||
+++
|
||||
|
||||
> Hello, world!
|
12
content/posts/todo/virtualizing-a-nas/index.md
Normal file
@ -0,0 +1,12 @@
|
||||
+++
|
||||
title = "Virtualizing a NAS"
|
||||
summary = "How to put the guts of a physical NAS into a VM"
|
||||
date = "2038-01-19"
|
||||
|
||||
tags = ["NAS", "VM", "BTRFS", "Compression", "Copy-on-write"]
|
||||
categories = ["Things I've done"]
|
||||
|
||||
draft = true
|
||||
+++
|
||||
|
||||
> Hello, world!
|