feat(doorman): badge listener + decoder TDD + deploy scaffolding [#355]
Modern successor of the 2018 Perl doorman (snapshot in legacy/): bash+coreutils HID decoder, HA webhook dispatch, systemd unit. Offline decoder suite green (9 tests); shellcheck zero-warning. Umbrella #345. Work item: https://projects.knownelement.com/issues/355
This commit is contained in:
@@ -0,0 +1,23 @@
|
||||
# doorman config refs — copy to /etc/default/doorman on the reader host
|
||||
# (root:root 0600). Material values live only on the host; this file is
|
||||
# references/placeholders only, never real tokens.
|
||||
|
||||
# HA webhook. The token is part of the URL path — treat as secret.
|
||||
DOORMAN_WEBHOOK_URL=https://<ha-host>/api/webhook/<token>
|
||||
|
||||
# Reader label carried in webhook payloads (default: hostname)
|
||||
#DOORMAN_READER_NAME=pfvsvrpi
|
||||
|
||||
# Input device glob (default: /dev/input/by-id/*-event-kbd). Pin it to the
|
||||
# reader's by-id name once hardware is confirmed (questions-v1 Q2).
|
||||
#DOORMAN_DEVICE=/dev/input/by-id/usb-13ba_Barcode_Reader-event-kbd
|
||||
|
||||
# Optional relay/actuator path — pending questions-v1 Q1 (usbrelay vs e-lock).
|
||||
# Native HA webhooks always answer 200, so keep UNLOCK_ON_2XX false and let
|
||||
# HA drive the actuator; flip only if HA returns real accept/deny codes.
|
||||
#DOORMAN_UNLOCK_ON_2XX=false
|
||||
#DOORMAN_RELAY_DEV=3X9XI_1
|
||||
#DOORMAN_USBRELAY=/usr/bin/usbrelay
|
||||
#DOORMAN_HOLD=10
|
||||
#DOORMAN_HTTP_TIMEOUT=10
|
||||
#DOORMAN_DEBUG=false
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
# Crush internal state (track crush.json config, ignore session data)
|
||||
.crush/crush.db
|
||||
.crush/crush.db-*
|
||||
.crush/logs/
|
||||
.crush/memory/
|
||||
.crush/active-ticket
|
||||
|
||||
# OS/editor
|
||||
.DS_Store
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
\#*\#
|
||||
.\#*
|
||||
|
||||
# Temporary files
|
||||
*.tmp
|
||||
*.bak
|
||||
*.log.tmp
|
||||
|
||||
# Framework artifacts (Logging.sh appends $0.<Day>-<ts>.$$ log files)
|
||||
*.Monday-*
|
||||
*.Tuesday-*
|
||||
*.Wednesday-*
|
||||
*.Thursday-*
|
||||
*.Friday-*
|
||||
*.Saturday-*
|
||||
*.Sunday-*
|
||||
@@ -0,0 +1,51 @@
|
||||
# Agent Guidelines — KNEL/doorman
|
||||
|
||||
Physical access control: badge-reader listener + tooling. Modern successor
|
||||
of the 2018 Perl doorman (`legacy/doorman.pl`, snapshot from
|
||||
[KNEL/LegacyTechops](https://git.knownelement.com/KNEL/LegacyTechops)).
|
||||
|
||||
House rules layering: `~/.zcode/AGENTS.md` (global) < PFVCluster
|
||||
`AGENTS.md` (workspace) < THIS FILE. The more specific file wins.
|
||||
|
||||
## Authority (NON-NEGOTIABLE)
|
||||
|
||||
- No work without an approved Redmine ticket. Active work: **#355**
|
||||
(code & testing, laptop/office), under umbrella **#345**; deployment is
|
||||
**#356**. NEVER close tickets without explicit human permission.
|
||||
- Ticket gate: `echo '#NNN' > .crush/active-ticket` before any modifying
|
||||
work; clear when done.
|
||||
- Propose, never implement out-of-scope findings — open a sub-ticket.
|
||||
- Security/access changes (door hardware, unlock policy, whitelists) are
|
||||
POLICY decisions — the human decides; the agent implements.
|
||||
|
||||
## Access channels
|
||||
|
||||
- SSH only (sshd is the only approved remote path). The qemu guest-agent
|
||||
is NEVER an execution channel. `qm guest exec` is banned mechanically.
|
||||
- All SSH to fleet hosts routes through the PFVCluster chokepoints:
|
||||
[tests/remote.sh](https://git.knownelement.com/KNEL/PFVCluster/src/branch/main/tests/remote.sh).
|
||||
- DNS names only — never IP literals.
|
||||
|
||||
## Scope boundary: Home Assistant
|
||||
|
||||
The HA side (webhook receiver, whitelist, automations, alerts) is owned by
|
||||
the parallel pfv-bms session/repo. This repo ships ONLY the reader-host
|
||||
side + the webhook contract documented in README.md. Do not edit
|
||||
KNEL/pfv-bms from here.
|
||||
|
||||
## Engineering
|
||||
|
||||
- TDD red/green for all code (`scripts/test.sh` is the local gate).
|
||||
- shellcheck zero-warning (info included) via `bash tests/shellcheck.sh`.
|
||||
- This daemon stays bash + coreutils ONLY — the reader Pi gets no package
|
||||
installs, no CPAN, no Python (ruling 2026-08-31).
|
||||
- NEVER restart/kill both readers simultaneously: deploy to the dev reader
|
||||
host (ultix-field), verify, then prod (pfvsvrpi) — serial, health-gated.
|
||||
- Every command touching a remote host gets `timeout` (30s/120s/300s).
|
||||
- Commit+push as work lands; conventional format; `[#NNN]` in subjects.
|
||||
|
||||
## Docs
|
||||
|
||||
Discourse is the documentation SoR
|
||||
([VP TechOps](https://community.turnsys.com/c/vp-techops)). Repo .md files
|
||||
are pointers or operational docs that must live beside code (this README).
|
||||
@@ -0,0 +1,235 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
FetchApply
|
||||
Copyright (C) 2024 VpTechnicalOperations
|
||||
|
||||
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/>.
|
||||
@@ -0,0 +1,10 @@
|
||||
# STATUS
|
||||
|
||||
→ Canonical operations status lives on Discourse:
|
||||
[#297 — Operations Status](https://community.turnsys.com/t/297)
|
||||
|
||||
Point-in-time (agent-owned, super sparse):
|
||||
|
||||
- Active: **#355** — badge system code & testing (KNEL/doorman repo)
|
||||
- Umbrella: #345 physical access control; deployment: #356 (onsite)
|
||||
- HA-side work: parallel pfv-bms session (out of this repo's scope)
|
||||
@@ -0,0 +1,7 @@
|
||||
# WORKING — session scratchpad (cleared at session close)
|
||||
|
||||
- [x] TDD: decoder suite red -> green (9 tests, tests/run-tests.sh)
|
||||
- [x] bin/doorman.sh listener (bash + coreutils only)
|
||||
- [x] systemd unit + /etc/default/doorman env refs
|
||||
- [x] shellcheck clean (tests/shellcheck.sh, docker)
|
||||
- [x] enforcement scripts adopted from TSYSGroupAIOS/PFVCluster
|
||||
Executable
+217
@@ -0,0 +1,217 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# bin/doorman.sh — badge scan listener (modern doorman).
|
||||
#
|
||||
# Successor of the 2018 Perl doorman (LegacyTechops/doorman/doorman.pl):
|
||||
# decodes badge IDs from a keyboard-emulating USB RFID reader on
|
||||
# /dev/input/by-id and hands each completed scan to a Home Assistant
|
||||
# webhook. Auth decision, whitelist, logging and the door actuator live
|
||||
# in HA (#345 architecture); this daemon is intentionally dumb so a
|
||||
# compromised reader host cannot hold the whitelist.
|
||||
#
|
||||
# Zero non-coreutils dependencies (no CPAN, no package installs): events
|
||||
# are read with od(1) and decoded with awk(1). Record width auto-detects
|
||||
# 24 bytes (64-bit kernel) vs 16 bytes (32-bit kernel, e.g. older Pis).
|
||||
#
|
||||
# Usage:
|
||||
# bin/doorman.sh # live listener
|
||||
# bin/doorman.sh --selftest FILE [--width 24|16]
|
||||
# # decode a fixture, print IDs
|
||||
#
|
||||
# Config (env; see .env.example):
|
||||
# DOORMAN_DEVICE glob of input devices (default *-event-kbd)
|
||||
# DOORMAN_WEBHOOK_URL HA webhook; unset = log-only mode
|
||||
# DOORMAN_READER_NAME reader label for webhook payloads (default hostname)
|
||||
# DOORMAN_UNLOCK_ON_2XX drive the relay on a 2xx webhook response
|
||||
# (default false — native HA webhooks always 200,
|
||||
# so leave false and let HA drive the actuator)
|
||||
# DOORMAN_RELAY_DEV usbrelay device.channel (e.g. 3X9XI_1)
|
||||
# DOORMAN_USBRELAY path to usbrelay (default /usr/bin/usbrelay)
|
||||
# DOORMAN_HOLD relay hold seconds (default 10)
|
||||
# DOORMAN_HTTP_TIMEOUT webhook curl --max-time (default 10)
|
||||
# DOORMAN_DEBUG "true" also mirrors logs to stderr
|
||||
#
|
||||
set -u
|
||||
|
||||
SELF="$(basename "$0")"
|
||||
WIDTH=""
|
||||
MODE="live"
|
||||
SELFTEST_FILE=""
|
||||
|
||||
log() {
|
||||
logger -t doorman -- "$1" 2>/dev/null || true
|
||||
if [ "${DOORMAN_DEBUG:-false}" = "true" ]; then
|
||||
printf '%s %s: %s\n' "$(date +%Y-%m-%dT%H:%M:%S%z)" "$SELF" "$1" >&2
|
||||
fi
|
||||
}
|
||||
|
||||
usage() {
|
||||
sed -n '2,40p' "$0" | sed 's/^# \{0,1\}//'
|
||||
}
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Decoding — the 2018 state machine, kept bit-identical:
|
||||
# * MSC_SCAN (type 4, code 4) events only; value & 127 is the HID usage.
|
||||
# * keytranslate: usages 0-9 pass through as digits (2018 quirk kept),
|
||||
# 30-38 -> 1-9, 39 -> 0, 40 = Enter terminator, anything else = bad.
|
||||
# * Parity: readers emit MSC_SCAN on BOTH press and release; a scan code
|
||||
# equal to the previous one is processed only on odd occurrences of the
|
||||
# run, so down/up pairs collapse to one digit.
|
||||
# * Bad usages log and skip WITHOUT clearing the partial badge (2018
|
||||
# behavior); Enter on an empty buffer emits nothing (defensive fix).
|
||||
# ---------------------------------------------------------------------------
|
||||
decode_stream() { # decode_stream <width> — od -t u1 records on stdin -> IDs
|
||||
awk -v w="$1" '
|
||||
{
|
||||
if (NF != w) { next }
|
||||
ti = w - 7; ci = w - 5; vi = w - 3
|
||||
if ($ti != 4 || $ci != 4) { next }
|
||||
v = $vi + 256 * $(vi + 1) + 65536 * $(vi + 2) + 16777216 * $(vi + 3)
|
||||
n = v % 128
|
||||
if (n == old && dupe == 0) { dupe = 1; next }
|
||||
else { dupe = 0 }
|
||||
# 2018 order matters: a bad usage nexts BEFORE the parity anchor
|
||||
# (oldvalue) is advanced — never move `old = n` above this check
|
||||
if ((n >= 10 && n <= 29) || n > 40) {
|
||||
printf "%s: problem reading ID (usage %d)\n", "'"$SELF"'", n > "/dev/stderr"
|
||||
next
|
||||
}
|
||||
old = n
|
||||
if (n <= 9) { id = id n; next } # 2018 keytranslate passthrough
|
||||
if (n <= 38) { id = id (n - 29); next } # usages 30-38 = digits 1-9
|
||||
if (n == 39) { id = id 0; next } # usage 39 = digit 0
|
||||
if (id != "") { print id } # usage 40 = Enter
|
||||
id = ""
|
||||
}
|
||||
' 2>/dev/null
|
||||
}
|
||||
|
||||
detect_width() {
|
||||
case "$(uname -m)" in
|
||||
i386 | i486 | i586 | i686 | armv*) printf '16\n' ;;
|
||||
*) printf '24\n' ;;
|
||||
esac
|
||||
}
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Live mode
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
fire_relay() {
|
||||
if [ -z "$DOORMAN_RELAY_DEV" ]; then
|
||||
log "unlock requested but DOORMAN_RELAY_DEV unset — ignoring"
|
||||
return 0
|
||||
fi
|
||||
log "unlock: relay ${DOORMAN_RELAY_DEV}=1 for ${DOORMAN_HOLD}s"
|
||||
(
|
||||
"$DOORMAN_USBRELAY" "${DOORMAN_RELAY_DEV}=1" >/dev/null 2>&1
|
||||
sleep "${DOORMAN_HOLD}"
|
||||
"$DOORMAN_USBRELAY" "${DOORMAN_RELAY_DEV}=0" >/dev/null 2>&1
|
||||
log "lock: relay ${DOORMAN_RELAY_DEV}=0"
|
||||
) &
|
||||
}
|
||||
|
||||
process_scan() {
|
||||
local id="$1" code rc body reader ts
|
||||
ts="$(date +%Y-%m-%dT%H:%M:%S%z)"
|
||||
reader="${DOORMAN_READER_NAME:-$(hostname)}"
|
||||
log "ID $id scanned."
|
||||
if [ -z "$DOORMAN_WEBHOOK_URL" ]; then
|
||||
log "no webhook configured (DOORMAN_WEBHOOK_URL) — scan logged only"
|
||||
return 0
|
||||
fi
|
||||
# badge IDs are digits by construction; reader/ts are env/hostname —
|
||||
# the JSON below cannot carry user-controlled quotes or backslashes
|
||||
body="$(printf '{"badge_id":"%s","reader":"%s","ts":"%s"}' "$id" "$reader" "$ts")"
|
||||
code="$(curl -sS --max-time "$DOORMAN_HTTP_TIMEOUT" \
|
||||
-H 'Content-Type: application/json' -d "$body" \
|
||||
-w '%{http_code}' "$DOORMAN_WEBHOOK_URL" 2>/dev/null)"
|
||||
rc=$?
|
||||
if [ "$rc" -ne 0 ] || [ -z "$code" ]; then
|
||||
log "webhook error (curl rc=$rc) — scan dropped, fail-closed"
|
||||
return 0
|
||||
fi
|
||||
log "webhook responded $code"
|
||||
if [ "${DOORMAN_UNLOCK_ON_2XX:-false}" = "true" ] \
|
||||
&& [ "$code" -ge 200 ] 2>/dev/null && [ "$code" -lt 300 ] 2>/dev/null; then
|
||||
fire_relay
|
||||
fi
|
||||
}
|
||||
|
||||
stream_device() {
|
||||
local dev="$1"
|
||||
log "listening on $dev (record width $WIDTH)"
|
||||
# stdbuf: od/awk block-buffer when piped; scans must not lag behind
|
||||
stdbuf -oL od -v -A n -t u1 -w"$WIDTH" "$dev" 2>/dev/null \
|
||||
| stdbuf -oL decode_stream "$WIDTH" \
|
||||
| while read -r bid; do
|
||||
process_scan "$bid"
|
||||
done
|
||||
}
|
||||
|
||||
run_live() {
|
||||
local -a devs=()
|
||||
# shellcheck disable=SC2206 # DOORMAN_DEVICE is an intentional glob
|
||||
devs=($DOORMAN_DEVICE)
|
||||
local d
|
||||
for d in "${devs[@]}"; do
|
||||
if [ ! -r "$d" ]; then
|
||||
log "input device not readable, skipping: $d"
|
||||
else
|
||||
stream_device "$d" &
|
||||
fi
|
||||
done
|
||||
if [ "${#devs[@]}" -eq 0 ]; then
|
||||
log "no input devices matched: $DOORMAN_DEVICE"
|
||||
exit 1
|
||||
fi
|
||||
log "doorman started ($SELF, webhook ${DOORMAN_WEBHOOK_URL:-<unset>})"
|
||||
# shellcheck disable=SC2046 # jobs -p is a plain pid list
|
||||
trap 'kill -- $(jobs -p) 2>/dev/null' INT TERM
|
||||
wait
|
||||
log "all input streams ended — exiting (systemd will restart)"
|
||||
}
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Entry
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
while [ $# -gt 0 ]; do
|
||||
case "$1" in
|
||||
--selftest)
|
||||
MODE="selftest"
|
||||
SELFTEST_FILE="${2:?--selftest requires a fixture path}"
|
||||
shift 2
|
||||
;;
|
||||
--width)
|
||||
WIDTH="${2:?--width requires 24 or 16}"
|
||||
shift 2
|
||||
;;
|
||||
-h | --help)
|
||||
usage
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
printf '%s: unknown argument: %s\n' "$SELF" "$1" >&2
|
||||
usage >&2
|
||||
exit 2
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
[ -n "$WIDTH" ] || WIDTH="$(detect_width)"
|
||||
DOORMAN_HOLD="${DOORMAN_HOLD:-10}"
|
||||
DOORMAN_HTTP_TIMEOUT="${DOORMAN_HTTP_TIMEOUT:-10}"
|
||||
DOORMAN_USBRELAY="${DOORMAN_USBRELAY:-/usr/bin/usbrelay}"
|
||||
DOORMAN_DEVICE="${DOORMAN_DEVICE:-/dev/input/by-id/*-event-kbd}"
|
||||
|
||||
case "$MODE" in
|
||||
selftest)
|
||||
if [ ! -r "$SELFTEST_FILE" ]; then
|
||||
printf '%s: fixture not readable: %s\n' "$SELF" "$SELFTEST_FILE" >&2
|
||||
exit 1
|
||||
fi
|
||||
stdbuf -oL od -v -A n -t u1 -w"$WIDTH" "$SELFTEST_FILE" | decode_stream "$WIDTH"
|
||||
;;
|
||||
live) run_live ;;
|
||||
esac
|
||||
@@ -0,0 +1,19 @@
|
||||
[Unit]
|
||||
Description=doorman - badge scan listener (KNEL/doorman)
|
||||
Documentation=https://git.knownelement.com/KNEL/doorman
|
||||
After=network-online.target
|
||||
Wants=network-online.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
ExecStart=/opt/doorman/bin/doorman.sh
|
||||
EnvironmentFile=-/etc/default/doorman
|
||||
Restart=always
|
||||
RestartSec=5
|
||||
User=root
|
||||
# Runs as root only for raw /dev/input/* access on the reader Pi;
|
||||
# revisit with a dedicated input group once reader hardware is known.
|
||||
Nice=5
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
@@ -0,0 +1,242 @@
|
||||
#!/usr/bin/perl -W
|
||||
###############################################################################
|
||||
#
|
||||
# doorman.pl - Use inexpensive USB RFID reader to allow access to a physical
|
||||
# portal controlled by an inexpensive USB relay, via a background
|
||||
# HTTP portal for authentication.
|
||||
#
|
||||
#################################################################[ AJC 2018 ]##
|
||||
use strict;
|
||||
use Linux::Input;
|
||||
use Data::Dumper;
|
||||
use WWW::Mechanize;
|
||||
use File::Basename qw{basename};
|
||||
use IO::Select;
|
||||
|
||||
###############################################################################
|
||||
#
|
||||
# Configuration directoves
|
||||
#
|
||||
###############################################################################
|
||||
|
||||
# Direct /dev link to device. Use by-id when possible
|
||||
my $device = "/dev/input/by-id/usb-13ba_Barcode_Reader-event-kbd";
|
||||
|
||||
my $usbrelay = "/usr/bin/usbrelay";
|
||||
my $usbrelay_device = "3X9XI_1";
|
||||
|
||||
# The URL of the authentication server
|
||||
my $url = "http://doors.pfv.turnsys.net/";
|
||||
|
||||
# Location of syslog's userspace logger utility
|
||||
my $rsyslog = "/usr/bin/logger";
|
||||
|
||||
# Card IDs that bypass network auth
|
||||
my %backdoors = (
|
||||
|
||||
"0000000001" => 'Charles NW',
|
||||
"0000000002" => 'Josef C',
|
||||
|
||||
);
|
||||
|
||||
# For logging syslog messages to stdout as well as syslog.
|
||||
my $debug = "true";
|
||||
#my $debug = "false";
|
||||
|
||||
###############################################################################
|
||||
#
|
||||
# Subroutines
|
||||
#
|
||||
###############################################################################
|
||||
|
||||
#################################################
|
||||
# logger - Send logs to syslog, or stdout if
|
||||
# DEBUG is defined.
|
||||
#################################################
|
||||
sub logger {
|
||||
|
||||
my $logtext = shift;
|
||||
if ($debug eq "true") { print localtime() . " " . basename($0) . ": " . "$logtext\n" };
|
||||
system( $rsyslog . " \"" . basename($0) . ": " . "$logtext\"" );
|
||||
|
||||
}
|
||||
|
||||
#################################################
|
||||
# unlock_door - Handle the USB relay to unlock
|
||||
# actuator.
|
||||
#################################################
|
||||
sub unlock_door() {
|
||||
|
||||
system $usbrelay . " " . $usbrelay_device . "=1 >/dev/null 2>&1";
|
||||
sleep 10;
|
||||
system $usbrelay . " " . $usbrelay_device . "=0 >/dev/null 2>&1";
|
||||
logger "Locking door.";
|
||||
|
||||
return 0;
|
||||
|
||||
}
|
||||
|
||||
#################################################
|
||||
# authenticate - check backdoors and legit HTTP
|
||||
# source to see if ID is valid.
|
||||
# Unlocks door if appropriate.
|
||||
#################################################
|
||||
sub authenticate {
|
||||
|
||||
my $id = shift;
|
||||
|
||||
if ( defined $backdoors{$id} ) {
|
||||
|
||||
logger $backdoors{$id} . " override key accepted. Unlocking door.";
|
||||
unlock_door;
|
||||
|
||||
} else {
|
||||
|
||||
# Open a connection to auth server.
|
||||
my $connection = WWW::Mechanize->new( autocheck => 0, quiet => 1);
|
||||
$connection->get ($url . $id);
|
||||
|
||||
# Touch a file named as the card ID number to make the card work.
|
||||
if ($connection->status == 200) {
|
||||
|
||||
logger "Card $id is valid. Unlocking door.";
|
||||
unlock_door;
|
||||
|
||||
} else {
|
||||
|
||||
# File is not cleanly returned, so it's invalid.
|
||||
logger "Card $id is invalid! (" . $connection->status() . ")";
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
#################################################
|
||||
# keytranslate - Reduce the returned keypress
|
||||
# value, and translate into the
|
||||
# actual number pressed.
|
||||
#################################################
|
||||
sub keytranslate {
|
||||
|
||||
my $keypress = shift;
|
||||
|
||||
return 1 if ($keypress == 30);
|
||||
return 2 if ($keypress == 31);
|
||||
return 3 if ($keypress == 32);
|
||||
return 4 if ($keypress == 33);
|
||||
return 5 if ($keypress == 34);
|
||||
return 6 if ($keypress == 35);
|
||||
return 7 if ($keypress == 36);
|
||||
return 8 if ($keypress == 37);
|
||||
return 9 if ($keypress == 38);
|
||||
return 0 if ($keypress == 39);
|
||||
return $keypress;
|
||||
|
||||
}
|
||||
|
||||
|
||||
###############################################################################
|
||||
#
|
||||
# main - This is where the whole thing comes together.
|
||||
#
|
||||
###############################################################################
|
||||
|
||||
# scoped values for loop work
|
||||
my $oldvalue = 0;
|
||||
my $dupe_flag = 0;
|
||||
my $id = "";
|
||||
my $done_flag = 0;
|
||||
|
||||
# Open all USB input devices, and stash in a hash until needed.
|
||||
my @devicenames = map { "/dev/input/by-id/" . basename($_) } </dev/input/by-id/*>;
|
||||
my %devices;
|
||||
|
||||
my $selector = IO::Select->new();
|
||||
|
||||
foreach (@devicenames) {
|
||||
my $device = Linux::Input->new($_);
|
||||
$selector->add($device->fh);
|
||||
$devices{$device->fh} = $device;
|
||||
}
|
||||
|
||||
logger basename($0) . " started.";
|
||||
|
||||
system $usbrelay . " " . $usbrelay_device . "=0 >/dev/null 2>&1";
|
||||
|
||||
|
||||
# stay in an infinite loop.
|
||||
while ( 1 ) {
|
||||
|
||||
# Do this if we have a device with some input
|
||||
while (my @fh = $selector->can_read) {
|
||||
|
||||
# For each file handle that has stuff to read
|
||||
foreach my $fh (@fh) {
|
||||
|
||||
my $input = $devices{$fh};
|
||||
|
||||
# Read the input that's waiting
|
||||
while (my @events = $input->poll(0.01)) {
|
||||
|
||||
# Convert keystrokes to useful data
|
||||
foreach (@events) {
|
||||
# break up the input struct into useful scalars.
|
||||
my $code = %$_{code};
|
||||
my $value = %$_{value};
|
||||
my $type = %$_{type};
|
||||
my $number = keytranslate($value & 127);
|
||||
|
||||
# This seems to indicate a KEYP/KEYDOWN event
|
||||
if ( $code == 4 && $type == 4 ) {
|
||||
|
||||
|
||||
# If we just saw this, it's KEYUP now, so ignore
|
||||
if ($value == $oldvalue && $dupe_flag == 0) {
|
||||
$dupe_flag = 1;
|
||||
next
|
||||
} else {
|
||||
$dupe_flag = 0;
|
||||
}
|
||||
|
||||
# 0-9 for number, 40 for end of string.
|
||||
if ( $number > 9 && $number != 40) { logger "Problem reading ID\n"; next}
|
||||
|
||||
if ( $number == 40) {
|
||||
$done_flag = 1;
|
||||
} else {
|
||||
$id .= $number;
|
||||
}
|
||||
|
||||
$oldvalue = $value;
|
||||
|
||||
} # if ($code == 4 && $type == 4)
|
||||
|
||||
} # foreach (@events)
|
||||
|
||||
} # while (my @events = $input->poll(0.01))
|
||||
|
||||
} # foreach my $fh (@fh)
|
||||
|
||||
# Do something with the completed code.
|
||||
if ( $done_flag == 1) {
|
||||
|
||||
logger "ID $id scanned.";
|
||||
|
||||
authenticate($id);
|
||||
|
||||
$id = "";
|
||||
$done_flag = 0;
|
||||
|
||||
} else {
|
||||
|
||||
next
|
||||
|
||||
}
|
||||
|
||||
} # while (my @fh = $selector->can_read)
|
||||
|
||||
|
||||
} # while (1)
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
#!/usr/bin/perl -W
|
||||
###############################################################################
|
||||
#
|
||||
# doorman.pl - Use inexpensive USB RFID reader to allow access to a physical
|
||||
# portal controlled by an inexpensive USB relay, via a background
|
||||
# HTTP portal for authentication.
|
||||
#
|
||||
#################################################################[ AJC 2018 ]##
|
||||
use warnings;
|
||||
use strict;
|
||||
use Linux::Input;
|
||||
use IO::Select;
|
||||
use File::Basename qw{basename};
|
||||
use Data::Dumper;
|
||||
|
||||
###############################################################################
|
||||
#
|
||||
# Configuration directoves
|
||||
#
|
||||
###############################################################################
|
||||
|
||||
# Direct /dev link to device. Use by-id when possible
|
||||
|
||||
###############################################################################
|
||||
#
|
||||
# main - This is where the whole thing comes together.
|
||||
#
|
||||
###############################################################################
|
||||
sub main {
|
||||
|
||||
# Add all input devices
|
||||
my @devicenames = map { "/dev/input/by-id/" . basename($_) } </dev/input/by-id/*>;
|
||||
my %devices;
|
||||
|
||||
my $selector = IO::Select->new();
|
||||
|
||||
foreach (@devicenames) {
|
||||
my $device = Linux::Input->new($_);
|
||||
$selector->add($device->fh);
|
||||
$devices{$device->fh} = $device;
|
||||
}
|
||||
|
||||
while(1) {
|
||||
|
||||
while (my @fh = $selector->can_read) {
|
||||
foreach my $fh (@fh) {
|
||||
my $input = $devices{$fh};
|
||||
while (my @events = $input->poll(0.01)) {
|
||||
foreach (@events) {
|
||||
print Dumper($_);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
main();
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# Questions — v1
|
||||
|
||||
None open in this repo.
|
||||
|
||||
The active badge-modernization Q&A round (actuator path Q1, reader
|
||||
model/format Q2, whitelist home Q3) lives in the PFVCluster repo:
|
||||
`questions-v4.md`. Answers land there; they gate deployment (#356), not
|
||||
the listener code.
|
||||
Executable
+274
@@ -0,0 +1,274 @@
|
||||
#!/usr/bin/env bash
|
||||
# check-rules.sh — project rule audit engine.
|
||||
#
|
||||
# Usage:
|
||||
# bash scripts/check-rules.sh # full audit (verbose, includes slow checks)
|
||||
# bash scripts/check-rules.sh --fast # fast audit (quiet, skips slow checks) — for pre-commit
|
||||
# bash scripts/check-rules.sh --quiet # full audit, only prints failures
|
||||
#
|
||||
# Exit code: 0 = all rules pass (warnings are non-fatal), 1 = one or more FAILED.
|
||||
#
|
||||
# This is a generalized version of the rules engine proven in the
|
||||
# RCEO-PersonalAssistant project. Add project-specific checks by appending
|
||||
# `check "<desc>" "<pass|warn|fail>"` calls below.
|
||||
set -euo pipefail
|
||||
|
||||
HERE="$(cd "$(dirname "$0")" && pwd)"
|
||||
# shellcheck disable=SC1091
|
||||
source "$HERE/lib/common.sh"
|
||||
REPO_ROOT="$(repo_root)"
|
||||
cd "$REPO_ROOT"
|
||||
|
||||
# --- argument parsing ---
|
||||
RULE_FAST=false
|
||||
RULE_VERBOSE=true
|
||||
for arg in "$@"; do
|
||||
case "$arg" in
|
||||
--fast) RULE_FAST=true; RULE_VERBOSE=false ;;
|
||||
--quiet) RULE_VERBOSE=false ;;
|
||||
*) die "check-rules.sh: unknown argument '$arg'" ;;
|
||||
esac
|
||||
done
|
||||
export RULE_FAST RULE_VERBOSE
|
||||
|
||||
init_counters
|
||||
$RULE_VERBOSE && echo "=== Project Rule Audit ==="
|
||||
|
||||
TODAY="$(date +%Y-%m-%d)"
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 1. Shellcheck — every .sh/.bash must pass (zero warnings, incl. info-level).
|
||||
# Runs in Docker so the host stays clean (no native shellcheck required).
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "Shell scripts (shellcheck)"
|
||||
mapfile -d '' SH_FILES < <(find . -path ./.git -prune -o -path ./.tmp -prune -o -path ./.crush -prune -o -path ./vendor -prune -o -path ./oam/librenms-agent/agent -prune -o -path ./archive -prune -o -path ./node_modules -prune -o \( -name '*.sh' -o -name '*.bash' \) -print0 2>/dev/null)
|
||||
if [ "${#SH_FILES[@]}" -gt 0 ]; then
|
||||
if have shellcheck; then
|
||||
if shellcheck "${SH_FILES[@]}" >/dev/null 2>&1; then
|
||||
check "All shell scripts pass shellcheck (host)" "pass"
|
||||
else
|
||||
check "shellcheck reports violations — run: shellcheck <file>" "fail"
|
||||
fi
|
||||
elif have docker; then
|
||||
MNT_FILES=()
|
||||
for f in "${SH_FILES[@]}"; do MNT_FILES+=("/mnt/${f#./}"); done
|
||||
if docker run --rm -v "$REPO_ROOT:/mnt" koalaman/shellcheck:stable "${MNT_FILES[@]}" >/dev/null 2>&1; then
|
||||
check "All shell scripts pass shellcheck (docker)" "pass"
|
||||
else
|
||||
check "shellcheck (docker) reports violations" "fail"
|
||||
fi
|
||||
else
|
||||
check "No shellcheck or docker available to lint scripts" "warn"
|
||||
fi
|
||||
else
|
||||
check "No shell scripts to lint" "pass"
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 2. Docker image pinning — no ':latest' tags in compose or Dockerfiles.
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "Docker image pinning"
|
||||
if grep -rqE '(image:|FROM).*:latest' --include='docker-compose*.y*ml' --include='Dockerfile*' . 2>/dev/null; then
|
||||
check "No ':latest' image tags (pin everything)" "fail"
|
||||
else
|
||||
check "No ':latest' image tags" "pass"
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 2b. Container naming — every service in a docker-compose file MUST set an
|
||||
# explicit container_name (never rely on Docker's default <dir>_<n>).
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "Container naming"
|
||||
COMPOSE_FILES="$(find . -path ./.git -prune -o \( -name 'docker-compose*.yml' -o -name 'docker-compose*.yaml' -o -name 'compose.yml' -o -name 'compose.yaml' \) -print 2>/dev/null || true)"
|
||||
if [ -n "$COMPOSE_FILES" ]; then
|
||||
BAD=0
|
||||
while IFS= read -r cf; do
|
||||
[ -n "$cf" ] || continue
|
||||
# Count top-level service keys (2-space indent under services:) and
|
||||
# compare against the number of container_name: declarations.
|
||||
svc_count=$(awk '/^services:/{f=1;next} f&&/^[^[:space:]]/{f=0} f&&/^[[:space:]]{2}[[:alnum:]_-]+:[[:space:]]*$/{c++} END{print c+0}' "$cf")
|
||||
cn_count=$(grep -cE '^[[:space:]]*container_name:' "$cf" 2>/dev/null || echo 0)
|
||||
if [ "${svc_count:-0}" -gt 0 ] && [ "$cn_count" -lt "$svc_count" ]; then
|
||||
BAD=$((BAD + 1))
|
||||
fi
|
||||
done <<EOF
|
||||
$COMPOSE_FILES
|
||||
EOF
|
||||
if [ "$BAD" -eq 0 ]; then
|
||||
check "All compose services set container_name" "pass"
|
||||
else
|
||||
check "$BAD compose file(s) with services missing container_name" "fail"
|
||||
fi
|
||||
else
|
||||
check "No compose files (container-name check skipped)" "pass"
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 3. Required-files manifest — the files every project using this template owns.
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "Required files"
|
||||
REQUIRED_FILES="AGENTS.md STATUS.md .env.example scripts/check-rules.sh scripts/setup-hooks.sh"
|
||||
REQUIRED_FILES="$REQUIRED_FILES ${PROJECT_REQUIRED_FILES:-}"
|
||||
for f in $REQUIRED_FILES; do
|
||||
if [ -f "$f" ]; then check "$f exists" "pass"; else check "$f MISSING" "fail"; fi
|
||||
done
|
||||
if compgen -G 'questions-v*.md' > /dev/null; then
|
||||
latest_q="$(find . -maxdepth 1 -name 'questions-v*.md' -printf '%f\n' | sort -V | tail -1)"
|
||||
check "questions-v*.md exists ($latest_q)" "pass"
|
||||
else
|
||||
check "questions-v*.md MISSING" "fail"
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 4. Doc freshness — STATUS.md touched today.
|
||||
# Warning (not failure): staleness is a signal, not a break.
|
||||
# Redmine is the system of record for work; Discourse for docs. STATUS.md is
|
||||
# a scratchpad only — see BASELINE-PROMPT.md §3, §8.
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "Doc freshness"
|
||||
if [ -f STATUS.md ]; then
|
||||
STATUS_DATE="$(grep -oE 'Last updated: [0-9]{4}-[0-9]{2}-[0-9]{2}' STATUS.md | grep -oE '[0-9]{4}-[0-9]{2}-[0-9]{2}' || echo unknown)"
|
||||
if [ "$STATUS_DATE" = "$TODAY" ]; then
|
||||
check "STATUS.md updated today ($STATUS_DATE)" "pass"
|
||||
else
|
||||
check "STATUS.md is stale (last: $STATUS_DATE, today: $TODAY) — update it" "warn"
|
||||
fi
|
||||
else
|
||||
check "STATUS.md MISSING" "fail"
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 4b. Discourse pointer-header policy (MANDATORY).
|
||||
# Discourse is the system of record for documentation. In-repo .md files are
|
||||
# stubs that point to a Discourse topic URL. Operational files exempt.
|
||||
# Override exemptions via PROJECT_DOC_EXEMPT (space-separated globs of
|
||||
# basenames) and the Discourse host via PROJECT_DISCOURSE_HOST.
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "Discourse pointer-header"
|
||||
DISCOURSE_HOST="${PROJECT_DISCOURSE_HOST:-community.turnsys.com}"
|
||||
DOC_EXEMPT="${PROJECT_DOC_EXEMPT:-AGENTS.md STATUS.md WORKING.md README.md ADOPTING.md LICENSE .env.example questions-v*.md BASELINE-PROMPT.md PATTERNS.md}"
|
||||
POINTER_MISSING=0
|
||||
while IFS= read -r -d '' f; do
|
||||
base="$(basename "$f")"
|
||||
exempt=false
|
||||
for pat in $DOC_EXEMPT; do
|
||||
# shellcheck disable=SC2254
|
||||
case "$base" in $pat) exempt=true; break ;; esac
|
||||
done
|
||||
[ "$exempt" = true ] && continue
|
||||
if ! grep -qF "$DISCOURSE_HOST" "$f" 2>/dev/null; then
|
||||
if [ "$POINTER_MISSING" -eq 0 ]; then
|
||||
$RULE_VERBOSE && printf ' %s\n' "Missing $DISCOURSE_HOST URL in:"
|
||||
fi
|
||||
POINTER_MISSING=$((POINTER_MISSING + 1))
|
||||
$RULE_VERBOSE && printf ' %s\n' "$f"
|
||||
fi
|
||||
done < <(find . -path ./.git -prune -o -path ./.crush -prune -o -path ./.tmp -prune -o -path ./vendor -prune -o -path ./archive -prune -o -name '*.md' -print0 2>/dev/null)
|
||||
if [ "$POINTER_MISSING" -eq 0 ]; then
|
||||
check "All non-exempt .md cite Discourse ($DISCOURSE_HOST)" "pass"
|
||||
else
|
||||
check "$POINTER_MISSING .md file(s) missing Discourse pointer (see BASELINE-PROMPT.md §3)" "fail"
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 5. Git state — uncommitted changes are a warning (the pre-push hook hardens
|
||||
# this where it matters).
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "Git state"
|
||||
if git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
|
||||
if git diff --quiet && git diff --cached --quiet; then
|
||||
check "Working tree clean" "pass"
|
||||
else
|
||||
check "Uncommitted changes present" "warn"
|
||||
fi
|
||||
else
|
||||
check "Not a git repo (git checks skipped)" "pass"
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 6. Hooks installed — self-check that git hooks were set up.
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "Git hooks"
|
||||
if [ -f .git/hooks/pre-commit ]; then
|
||||
check "pre-commit hook installed" "pass"
|
||||
else
|
||||
check "pre-commit NOT installed (run: bash scripts/setup-hooks.sh)" "warn"
|
||||
fi
|
||||
if [ -f .git/hooks/pre-push ]; then
|
||||
check "pre-push hook installed" "pass"
|
||||
else
|
||||
check "pre-push NOT installed (run: bash scripts/setup-hooks.sh)" "warn"
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 7. WORKING.md completion — no unchecked tasks may remain at commit time.
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "Task completion"
|
||||
if [ -f WORKING.md ]; then
|
||||
UNCHECKED="$(grep -cF -- '- [ ]' WORKING.md || true)"
|
||||
if [ "$UNCHECKED" -eq 0 ]; then
|
||||
check "WORKING.md has no unchecked tasks" "pass"
|
||||
else
|
||||
check "WORKING.md has ${UNCHECKED} unchecked task(s) — finish them before committing" "fail"
|
||||
fi
|
||||
else
|
||||
check "WORKING.md absent (no active task tracker)" "pass"
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 8. CNW markers — empty `CNW:` markers flag unresolved questions for the human.
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "Unresolved questions"
|
||||
EMPTY_CNW="$(grep -rn 'CNW:$' . --include='*.md' 2>/dev/null | head -20 || true)"
|
||||
if [ -z "$EMPTY_CNW" ]; then
|
||||
check "No empty CNW: markers (unresolved questions)" "pass"
|
||||
else
|
||||
CNW_COUNT="$(printf '%s\n' "$EMPTY_CNW" | grep -c . || true)"
|
||||
check "${CNW_COUNT} unresolved CNW: marker(s) — needs user input" "warn"
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 9. Hygiene — merge-conflict markers and trailing whitespace must never land.
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "File hygiene"
|
||||
if git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
|
||||
# archive/ excluded: legacy files are preserved verbatim and may contain
|
||||
# decorative `====` banners that false-positive as conflict markers.
|
||||
CONFLICT="$(git diff --cached --name-only --diff-filter=ACM 2>/dev/null | grep -v '^archive/' | xargs -r grep -lE '^(<<<<<<<|=======|>>>>>>>)' 2>/dev/null || true)"
|
||||
if [ -z "$CONFLICT" ]; then check "No merge-conflict markers staged" "pass"; else check "Merge-conflict markers staged: $CONFLICT" "fail"; fi
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 10. (slow, skipped in --fast) Project test suite via scripts/test.sh.
|
||||
# ----------------------------------------------------------------------------
|
||||
if [ "$RULE_FAST" = false ] && [ -x scripts/test.sh ]; then
|
||||
$RULE_VERBOSE && log_step "Test suite (scripts/test.sh)"
|
||||
if bash scripts/test.sh >/dev/null 2>&1; then
|
||||
check "scripts/test.sh passes" "pass"
|
||||
else
|
||||
check "scripts/test.sh FAILS" "fail"
|
||||
fi
|
||||
fi
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# 11. Access-channel policy — qemu guest-agent must NEVER be used as an
|
||||
# execution or key-delivery channel. SSH (sshd) is the ONLY approved
|
||||
# remote access path; all commands must be logged through standard
|
||||
# auth/audit infrastructure. ITAR/CMMC environment — non-negotiable.
|
||||
# Allowed: installing/checking qemu-guest-agent for Proxmox state
|
||||
# visibility. Forbidden: `qm guest exec` + any `vm-guest` wrapper.
|
||||
# Scans CODE only (not .md) so docs may describe the ban.
|
||||
# ----------------------------------------------------------------------------
|
||||
$RULE_VERBOSE && log_step "Access-channel policy (no guest-agent exec)"
|
||||
GA_HITS="$(grep -rnE 'qm guest exec|vm-guest|_vm_guest' \
|
||||
--include='*.sh' --include='*.bash' --include='*.py' \
|
||||
. 2>/dev/null | grep -vE 'scripts/check-rules\.sh|/archive/' || true)"
|
||||
if [ -z "$GA_HITS" ]; then
|
||||
check "No guest-agent exec / vm-guest access patterns in code" "pass"
|
||||
else
|
||||
GA_COUNT="$(printf '%s\n' "$GA_HITS" | grep -c . || true)"
|
||||
$RULE_VERBOSE && printf '%s\n' "$GA_HITS" | sed 's/^/ /'
|
||||
check "${GA_COUNT} guest-agent exec / vm-guest reference(s) — SSH-only access policy (AGENTS.md)" "fail"
|
||||
fi
|
||||
|
||||
print_summary_and_exit
|
||||
@@ -0,0 +1,137 @@
|
||||
#!/usr/bin/env bash
|
||||
# lib/common.sh — shared helpers for shell scripts and hooks in this repo.
|
||||
#
|
||||
# Source it from any script:
|
||||
# #!/usr/bin/env bash
|
||||
# set -euo pipefail
|
||||
# HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
# # shellcheck source=lib/common.sh
|
||||
# source "$HERE/lib/common.sh" # or the appropriate relative path
|
||||
#
|
||||
# This library exists to drive a known cross-project inconsistency to zero:
|
||||
# every repo used to re-paste the ANSI color block, redefine log_* helpers,
|
||||
# pick one of three incompatible shebangs, and roll its own docker wrapper.
|
||||
# Import this once instead.
|
||||
|
||||
# Do NOT set -euo pipefail here unconditionally — some callers (git hooks)
|
||||
# source this file and rely on controlling their own shell options. We only
|
||||
# guarantee the functions below are defined.
|
||||
|
||||
###############################################################################
|
||||
# Config — override via environment before sourcing if needed
|
||||
###############################################################################
|
||||
: "${TEMPLATE_ROOT:=$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)}"
|
||||
export TEMPLATE_ROOT
|
||||
|
||||
###############################################################################
|
||||
# ANSI colors (defined once, used everywhere)
|
||||
###############################################################################
|
||||
if [ -t 1 ] && [ -z "${NO_COLOR:-}" ]; then
|
||||
RED='\033[0;31m'; GREEN='\033[0;32m'; YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'; BOLD='\033[1m'; NC='\033[0m'
|
||||
else
|
||||
RED=''; GREEN=''; YELLOW=''; BLUE=''; BOLD=''; NC=''
|
||||
fi
|
||||
export RED GREEN YELLOW BLUE BOLD NC
|
||||
|
||||
###############################################################################
|
||||
# Logging
|
||||
###############################################################################
|
||||
log_info() { printf "${BLUE}›${NC} %s\n" "$*"; }
|
||||
log_ok() { printf "${GREEN}✓${NC} %s\n" "$*"; }
|
||||
log_warn() { printf "${YELLOW}⚠${NC} %s\n" "$*" >&2; }
|
||||
log_error() { printf "${RED}✗${NC} %s\n" "$*" >&2; }
|
||||
log_step() { printf "\n${BOLD}== %s ==${NC}\n" "$*"; }
|
||||
|
||||
die() { log_error "$*"; exit 1; }
|
||||
|
||||
###############################################################################
|
||||
# Predicates
|
||||
###############################################################################
|
||||
# have <cmd> — return 0 if <cmd> is on PATH
|
||||
have() { command -v "$1" >/dev/null 2>&1; }
|
||||
|
||||
###############################################################################
|
||||
# Path helpers
|
||||
###############################################################################
|
||||
repo_root() {
|
||||
# Prefer git's notion of the repo root, fall back to $TEMPLATE_ROOT, then pwd.
|
||||
if git rev-parse --show-toplevel >/dev/null 2>&1; then
|
||||
git rev-parse --show-toplevel
|
||||
else
|
||||
printf '%s\n' "${TEMPLATE_ROOT:-$(pwd)}"
|
||||
fi
|
||||
}
|
||||
|
||||
###############################################################################
|
||||
# Privilege helpers
|
||||
###############################################################################
|
||||
# as_root — run the remaining args as root via sudo, or directly if already root.
|
||||
as_root() {
|
||||
if [ "$(id -u)" -eq 0 ]; then "$@"; else sudo "$@"; fi
|
||||
}
|
||||
|
||||
###############################################################################
|
||||
# Docker wrapper
|
||||
###############################################################################
|
||||
# docker_run <image> <args...>
|
||||
# Ephemeral container, host-uid ownership, repo mounted at /data, cwd /data.
|
||||
# Drives the "host stays clean; everything runs in containers" policy and
|
||||
# ensures output files are owned by the invoking user, not root.
|
||||
docker_run() {
|
||||
[ "$#" -ge 1 ] || die "docker_run: image required"
|
||||
local image="$1"; shift
|
||||
have docker || die "docker not found on PATH"
|
||||
local root
|
||||
root="$(repo_root)"
|
||||
docker run --rm \
|
||||
--user "$(id -u):$(id -g)" \
|
||||
-e HOME=/tmp \
|
||||
-v "$root:/data" \
|
||||
-w /data \
|
||||
"$image" "$@"
|
||||
}
|
||||
|
||||
###############################################################################
|
||||
# Rule-audit accumulator (used by scripts/check-rules.sh)
|
||||
# Globals read/written: RULE_PASS RULE_WARN RULE_FAIL
|
||||
###############################################################################
|
||||
init_counters() { RULE_PASS=0; RULE_WARN=0; RULE_FAIL=0; }
|
||||
|
||||
# check <description> <pass|warn|fail>
|
||||
check() {
|
||||
local desc="$1" result="$2"
|
||||
case "$result" in
|
||||
pass)
|
||||
RULE_PASS=$((RULE_PASS + 1))
|
||||
if [ "${RULE_VERBOSE:-true}" = true ]; then printf " ${GREEN}PASS${NC} %s\n" "$desc"; fi
|
||||
;;
|
||||
warn)
|
||||
RULE_WARN=$((RULE_WARN + 1))
|
||||
if [ "${RULE_VERBOSE:-true}" = true ]; then printf " ${YELLOW}WARN${NC} %s\n" "$desc"; fi
|
||||
;;
|
||||
fail)
|
||||
RULE_FAIL=$((RULE_FAIL + 1))
|
||||
printf " ${RED}FAIL${NC} %s\n" "$desc"
|
||||
;;
|
||||
*)
|
||||
die "check(): invalid result '$result' (use pass|warn|fail)"
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
# print_summary_and_exit
|
||||
print_summary_and_exit() {
|
||||
if [ "${RULE_VERBOSE:-true}" = true ]; then
|
||||
printf "\n=== Summary ===\n PASS: %s\n WARN: %s\n FAIL: %s\n\n" \
|
||||
"$RULE_PASS" "$RULE_WARN" "$RULE_FAIL"
|
||||
fi
|
||||
if [ "$RULE_FAIL" -gt 0 ]; then
|
||||
if [ "${RULE_VERBOSE:-true}" = true ]; then
|
||||
printf "AUDIT FAILED — %s rule(s) violated.\n" "$RULE_FAIL"
|
||||
fi
|
||||
exit 1
|
||||
fi
|
||||
if [ "${RULE_VERBOSE:-true}" = true ]; then printf "AUDIT PASSED.\n"; fi
|
||||
exit 0
|
||||
}
|
||||
Executable
+25
@@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env bash
|
||||
# pre-commit — fast rule audit (< 1s typical).
|
||||
# Hot-path bypass: commits that ONLY touch STATUS.md / WORKING.md skip the
|
||||
# audit so frequent status/task commits stay frictionless.
|
||||
set -euo pipefail
|
||||
|
||||
REPO_ROOT="$(git rev-parse --show-toplevel)"
|
||||
cd "$REPO_ROOT"
|
||||
|
||||
CHANGED="$(git diff --cached --name-only)"
|
||||
HOT_PATHS="$(printf '%s\n' "$CHANGED" | grep -vE '^(STATUS.md|WORKING.md)$' || true)"
|
||||
|
||||
if [ -z "$HOT_PATHS" ]; then
|
||||
echo "hot-path files only (STATUS/WORKING) — skipping rule audit"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if ! bash scripts/check-rules.sh --fast; then
|
||||
echo ""
|
||||
echo "pre-commit audit FAILED. Fix the violations above before committing."
|
||||
echo "Full audit: bash scripts/check-rules.sh"
|
||||
echo "Bypass: git commit --no-verify (emergencies only)"
|
||||
exit 1
|
||||
fi
|
||||
exit 0
|
||||
Executable
+25
@@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env bash
|
||||
# pre-push — full rule audit + clean-working-tree gate before pushing.
|
||||
# Installed via: bash scripts/setup-hooks.sh
|
||||
#
|
||||
# Combines two proven policies observed across projects:
|
||||
# - KNEL-AIMiddleware: block push if the working tree is dirty.
|
||||
# - RCEO-PersonalAssistant: block push if the full test suite fails.
|
||||
set -euo pipefail
|
||||
|
||||
REPO_ROOT="$(git rev-parse --show-toplevel)"
|
||||
cd "$REPO_ROOT"
|
||||
|
||||
echo "pre-push: running full rule audit..."
|
||||
|
||||
# Full audit (non-fast): runs the slow test suite via `make test` if present.
|
||||
if ! bash scripts/check-rules.sh --quiet; then
|
||||
echo ""
|
||||
echo "pre-push audit FAILED. Push blocked."
|
||||
echo "Re-run with output: bash scripts/check-rules.sh"
|
||||
echo "Bypass: git push --no-verify (emergencies only)"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "pre-push: all rules and tests passed."
|
||||
exit 0
|
||||
Executable
+44
@@ -0,0 +1,44 @@
|
||||
#!/usr/bin/env bash
|
||||
# setup-hooks.sh — install this repo's git hooks.
|
||||
#
|
||||
# Mechanism: copy scripts/pre-commit and scripts/pre-push into .git/hooks/ and
|
||||
# make them executable. This is the most portable pattern (works on any clone,
|
||||
# no `git config core.hooksPath` mutation, survives config resets, idempotent).
|
||||
#
|
||||
# Run once after cloning: bash scripts/setup-hooks.sh
|
||||
set -euo pipefail
|
||||
|
||||
HERE="$(cd "$(dirname "$0")" && pwd)"
|
||||
# shellcheck disable=SC1091
|
||||
source "$HERE/lib/common.sh"
|
||||
REPO_ROOT="$(repo_root)"
|
||||
cd "$REPO_ROOT"
|
||||
|
||||
[ -d .git ] || die "no .git directory here — run this from a git checkout"
|
||||
|
||||
HOOKS_DIR=".git/hooks"
|
||||
HOOK_NAMES="pre-commit pre-push"
|
||||
|
||||
log_step "Installing git hooks"
|
||||
for name in $HOOK_NAMES; do
|
||||
src="scripts/$name"
|
||||
dst="$HOOKS_DIR/$name"
|
||||
[ -f "$src" ] || die "source hook not found: $src"
|
||||
cp "$src" "$dst"
|
||||
chmod +x "$dst"
|
||||
log_ok "installed $dst"
|
||||
done
|
||||
|
||||
cat <<EOF
|
||||
|
||||
Git hooks installed. The following now run automatically:
|
||||
|
||||
pre-commit fast rule audit (shellcheck, image pinning, container naming,
|
||||
required files, doc freshness, Discourse pointers, WORKING.md
|
||||
completion, hygiene).
|
||||
Hot-path bypass for STATUS.md / WORKING.md.
|
||||
pre-push full rule audit (includes scripts/test.sh) + clean-working-tree gate.
|
||||
|
||||
Bypass either with \`git commit --no-verify\` / \`git push --no-verify\`
|
||||
(emergencies only).
|
||||
EOF
|
||||
Executable
+14
@@ -0,0 +1,14 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# scripts/test.sh — project test runner (framework entry point).
|
||||
#
|
||||
# LOCAL GATE: offline decoder unit suite; no hardware required (#355
|
||||
# scope: "test logic on the laptop").
|
||||
#
|
||||
set -uo pipefail
|
||||
cd "$(dirname "${BASH_SOURCE[0]}")/.." || exit 1
|
||||
|
||||
status=0
|
||||
bash tests/run-tests.sh || status=1
|
||||
|
||||
exit "$status"
|
||||
Executable
+186
@@ -0,0 +1,186 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# tests/run-tests.sh — doorman decoder unit tests (offline, no hardware).
|
||||
#
|
||||
# Builds synthetic /dev/input event streams (the exact binary records the
|
||||
# kernel emits) and asserts bin/doorman.sh --selftest decodes them the way
|
||||
# the 2018 Perl doorman did: digits 1-9 = HID usages 30-38, 0 = 39,
|
||||
# Enter = 40, each key arriving as a down/up MSC_SCAN pair that the
|
||||
# parity logic collapses to one digit.
|
||||
#
|
||||
# Usage: bash tests/run-tests.sh
|
||||
#
|
||||
set -uo pipefail
|
||||
|
||||
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||
BIN="$ROOT/bin/doorman.sh"
|
||||
TMP="$(mktemp -d)"
|
||||
trap 'rm -rf "$TMP"' EXIT
|
||||
|
||||
pass=0
|
||||
fail=0
|
||||
ok() { printf 'ok - %s\n' "$1"; pass=$((pass + 1)); }
|
||||
no() { printf 'FAIL - %s\n' "$1"; fail=$((fail + 1)); }
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixture builders
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
hex() { printf '\\x%02x' "$1"; }
|
||||
|
||||
# emit_event <width> <type> <code> <value> — one input_event record, LE.
|
||||
emit_event() {
|
||||
local w="$1" t="$2" c="$3" v="$4" tv
|
||||
if [ "$w" -eq 24 ]; then tv=16; else tv=8; fi
|
||||
# shellcheck disable=SC2046 # %.0s consumes the seq args; emits tv NULs
|
||||
printf '\x00%.0s' $(seq 1 "$tv") > "$TMP/ev.bin"
|
||||
{
|
||||
# type and code are __u16 LE, value is __s32 LE
|
||||
printf '%b' "$(hex $((t & 255)))$(hex $(((t >> 8) & 255)))$(hex $((c & 255)))$(hex $(((c >> 8) & 255)))"
|
||||
printf '%b' "$(hex $((v & 255)))$(hex $(((v >> 8) & 255)))$(hex $(((v >> 16) & 255)))$(hex $(((v >> 24) & 255)))"
|
||||
} >> "$TMP/ev.bin"
|
||||
cat "$TMP/ev.bin"
|
||||
}
|
||||
|
||||
# emit_scan <width> <usage> — one keypress: down + up MSC_SCAN + SYN filler.
|
||||
emit_scan() {
|
||||
emit_event "$1" 4 4 "$2"
|
||||
emit_event "$1" 4 4 "$2"
|
||||
emit_event "$1" 0 0 0
|
||||
}
|
||||
|
||||
# emit_badge <width> <digits...> — each digit + terminating Enter.
|
||||
emit_badge() {
|
||||
local w="$1"; shift
|
||||
local d u
|
||||
for d in "$@"; do
|
||||
if [ "$d" = "ENTER" ]; then u=40; else u=$((29 + 10#$d)); fi
|
||||
emit_scan "$w" "$u"
|
||||
done
|
||||
}
|
||||
|
||||
# emit_digits <width> <digits> — one scan event pair per digit (0 = usage 39,
|
||||
# 1-9 = usages 30-38). Takes the badge string itself, not precomputed usages.
|
||||
emit_digits() {
|
||||
local w="$1" s="$2" i d u
|
||||
for ((i = 0; i < ${#s}; i++)); do
|
||||
d="${s:$i:1}"
|
||||
if [ "$d" = "0" ]; then u=39; else u=$((29 + 10#$d)); fi
|
||||
emit_scan "$w" "$u"
|
||||
done
|
||||
}
|
||||
|
||||
# emit_enter <width> — the Enter terminator keypress.
|
||||
emit_enter() { emit_scan "$1" 40; }
|
||||
|
||||
run_selftest() { # run_selftest <fixture> [width]
|
||||
local w="${2:-24}"
|
||||
"$BIN" --selftest "$1" --width "$w" 2>/dev/null
|
||||
}
|
||||
|
||||
assert_ids() { # assert_ids <desc> <fixture> <expected...> [--width N]
|
||||
local desc="$1" fixture="$2"
|
||||
shift 2
|
||||
local w=24
|
||||
local -a exp=()
|
||||
while [ $# -gt 0 ]; do
|
||||
if [ "$1" = "--width" ]; then
|
||||
w="$2"
|
||||
shift 2
|
||||
else
|
||||
exp+=("$1")
|
||||
shift
|
||||
fi
|
||||
done
|
||||
local got expected
|
||||
got="$(run_selftest "$fixture" "$w")"
|
||||
expected="$(printf '%s\n' "${exp[@]}")"
|
||||
if [ "$got" = "$expected" ]; then
|
||||
ok "$desc"
|
||||
else
|
||||
no "$desc"
|
||||
printf ' expected: %s\n' "$(printf '%s | ' "${exp[@]}")"
|
||||
printf ' got: %s\n' "$(printf '%s' "$got" | tr '\n' ' ')"
|
||||
fi
|
||||
}
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
# T1: two full 10-digit badges + a repeated-digit badge ("11" exercises the
|
||||
# down/up parity state machine on consecutive identical scan codes).
|
||||
f1="$TMP/f1.bin"
|
||||
{
|
||||
emit_digits 24 "0000000001"; emit_enter 24
|
||||
emit_digits 24 "0000000002"; emit_enter 24
|
||||
emit_digits 24 "11"; emit_enter 24
|
||||
} > "$f1"
|
||||
assert_ids "T1 decodes two 10-digit badges + repeated-digit badge" "$f1" \
|
||||
"0000000001" "0000000002" "11"
|
||||
|
||||
# T2: garbage MSC_SCAN usage mid-badge (e.g. media key) must not corrupt
|
||||
# or truncate the scan (2018 behavior: log+skip, id preserved).
|
||||
f2="$TMP/f2.bin"
|
||||
{
|
||||
emit_digits 24 "000"
|
||||
emit_scan 24 42 # garbage usage (backspace) — must be skipped
|
||||
emit_digits 24 "0000001"
|
||||
emit_enter 24
|
||||
} > "$f2"
|
||||
assert_ids "T2 garbage scan usage mid-badge is skipped" "$f2" "0000000001"
|
||||
|
||||
# T3: lone Enter (empty scan) emits nothing.
|
||||
f3="$TMP/f3.bin"
|
||||
emit_enter 24 > "$f3"
|
||||
got="$(run_selftest "$f3")"
|
||||
if [ -z "$got" ]; then ok "T3 lone Enter emits no badge"; else no "T3 lone Enter emits no badge (got: $got)"; fi
|
||||
|
||||
# T4: non-MSC events (EV_KEY type 1) around a badge are ignored.
|
||||
f4="$TMP/f4.bin"
|
||||
{
|
||||
emit_event 24 1 30 1; emit_event 24 1 30 0
|
||||
emit_digits 24 "0"; emit_enter 24
|
||||
emit_event 24 1 30 1; emit_event 24 1 30 0
|
||||
} > "$f4"
|
||||
assert_ids "T4 EV_KEY events ignored, MSC_SCAN decoded" "$f4" "0"
|
||||
|
||||
# T5: truncated trailing record does not hang or corrupt output.
|
||||
f5="$TMP/f5.bin"
|
||||
{
|
||||
emit_digits 24 "7"; emit_enter 24
|
||||
emit_event 24 4 4 39
|
||||
printf '\x00\x00\x00' # 3-byte orphan tail
|
||||
} > "$f5"
|
||||
assert_ids "T5 truncated tail record ignored" "$f5" "7"
|
||||
|
||||
# T6: 16-byte records (32-bit boards, e.g. older Pis) decode identically.
|
||||
f6="$TMP/f6.bin"
|
||||
{ emit_digits 16 "0"; emit_enter 16; } > "$f6"
|
||||
assert_ids "T6 16-byte record width supported" "$f6" "0" --width 16
|
||||
|
||||
# T7: all-zero stream (idle bus) emits nothing.
|
||||
f7="$TMP/f7.bin"
|
||||
for _ in 1 2 3 4 5; do emit_event 24 0 0 0; done > "$f7"
|
||||
got="$(run_selftest "$f7")"
|
||||
if [ -z "$got" ]; then ok "T7 idle all-zero stream emits nothing"; else no "T7 idle stream (got: $got)"; fi
|
||||
|
||||
# T8: missing fixture file fails cleanly, not silently.
|
||||
if "$BIN" --selftest "$TMP/does-not-exist.bin" >/dev/null 2>&1; then
|
||||
no "T8 missing fixture exits nonzero"
|
||||
else
|
||||
ok "T8 missing fixture exits nonzero"
|
||||
fi
|
||||
|
||||
# T9: known 2018 backdoor badges replay end-to-end (regression anchor).
|
||||
f9="$TMP/f9.bin"
|
||||
{
|
||||
emit_digits 24 "0000000001"; emit_enter 24
|
||||
emit_digits 24 "0000000002"; emit_enter 24
|
||||
} > "$f9"
|
||||
assert_ids "T9 2018 backdoor badges decode verbatim" "$f9" \
|
||||
"0000000001" "0000000002"
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
printf '\n%d passed, %d failed\n' "$pass" "$fail"
|
||||
[ "$fail" -eq 0 ]
|
||||
Executable
+79
@@ -0,0 +1,79 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# tests/shellcheck.sh — enforce shellcheck (via Docker) on all repo shell scripts
|
||||
#
|
||||
# Usage:
|
||||
# bash tests/shellcheck.sh # lint every .sh in the repo
|
||||
# bash tests/shellcheck.sh path/a.sh # lint specific files
|
||||
#
|
||||
# Uses the koalaman/shellcheck:stable image (no native binary required).
|
||||
# Exits non-zero if ANY script emits a diagnostic.
|
||||
#
|
||||
set -uo pipefail
|
||||
|
||||
IMAGE="koalaman/shellcheck:stable"
|
||||
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||
|
||||
mapfile -t FILES < <(
|
||||
if [ "$#" -gt 0 ]; then
|
||||
for f in "$@"; do
|
||||
f_abs="$(cd "$(dirname "$f")" && pwd)/$(basename "$f")"
|
||||
case "$f_abs" in
|
||||
"$ROOT"/legacy/*) ;; # 2018 Perl snapshot, verbatim, not maintained
|
||||
*) case "$f_abs" in *.sh) echo "$f_abs" ;; esac ;;
|
||||
esac
|
||||
done
|
||||
else
|
||||
while IFS= read -r f_abs; do
|
||||
case "$f_abs" in
|
||||
"$ROOT"/legacy/*) ;; # 2018 Perl snapshot, verbatim, not maintained
|
||||
*) echo "$f_abs" ;;
|
||||
esac
|
||||
done < <(find "$ROOT" -type f -name '*.sh' \
|
||||
-not -path '*/.git/*' -not -path "$ROOT/.crush/*")
|
||||
fi
|
||||
)
|
||||
|
||||
if [ "${#FILES[@]}" -eq 0 ]; then
|
||||
echo "shellcheck.sh: no .sh files to check." >&2
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# --- Filter out non-bash scripts (e.g. PHP with a .sh extension) --------------
|
||||
BASH_FILES=()
|
||||
for f in "${FILES[@]}"; do
|
||||
shebang=$(head -c 64 "$f" 2>/dev/null | head -n1)
|
||||
case "$shebang" in
|
||||
\#!/usr/bin/php* | \#!/usr/bin/env\ php*) ;; # PHP, skip
|
||||
*) BASH_FILES+=("$f") ;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [ "${#BASH_FILES[@]}" -eq 0 ]; then
|
||||
echo "shellcheck.sh: no bash scripts among targets." >&2
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# shellcheck disable=SC2012 # basename loop is intentional
|
||||
REL=()
|
||||
for f in "${BASH_FILES[@]}"; do REL+=("${f#"$ROOT"/}"); done
|
||||
|
||||
# Intentional conventions of this codebase (not bugs):
|
||||
# SC1090/SC1091 — awk program paths & dynamic sourcing not followable
|
||||
DISABLES=(-e SC1090 -e SC1091)
|
||||
|
||||
echo "Checking ${#BASH_FILES[@]} script(s) with $IMAGE:"
|
||||
printf ' %s\n' "${REL[@]}"
|
||||
|
||||
docker run --rm \
|
||||
-v "$ROOT:/mnt:ro" \
|
||||
-w /mnt \
|
||||
"$IMAGE" -x "${DISABLES[@]}" "${REL[@]}"
|
||||
rc=$?
|
||||
|
||||
if [ "$rc" -eq 0 ]; then
|
||||
echo "shellcheck: PASS (${#BASH_FILES[@]} scripts clean)"
|
||||
else
|
||||
echo "shellcheck: FAIL (fix the findings above or add targeted disable directives)" >&2
|
||||
fi
|
||||
exit "$rc"
|
||||
Reference in New Issue
Block a user