Initial commit: captive-portal provisioning for esp-idf devices

b85db9e · Gabriel Morell · 2026-09-16 18:17

37 files +5053 -0
Message
{commit_body(@commit)}

Files changed

added .gitignore
+5 −0
@@ -0,0 +1,5 @@
1 +/target
2 +/Cargo.lock
3 +/web/node_modules
4 +/web/dist
5 +/.embuild
added Cargo.toml
+47 −0
@@ -0,0 +1,47 @@
1 +[package]
2 +name = "neiam-portal"
3 +version = "0.1.0"
4 +authors = ["gmorell <gmp@gmp.io>"]
5 +edition = "2021"
6 +rust-version = "1.82"
7 +license = "GPL-3.0-or-later"
8 +description = "Captive-portal provisioning and status web UI for ESP32 devices (esp-idf-svc)"
9 +
10 +[features]
11 +default = []
12 +# Adds the ready-made MQTT config fragment (`MqttConfig`) and switches the
13 +# built-in portal page to the variant that includes the broker form section.
14 +mqtt = []
15 +# Re-run the Tailwind/DaisyUI pipeline at build time instead of using the
16 +# pre-built assets checked into `assets/`. Requires Node.js + npm + network on
17 +# the first build. Only needed when restyling or when a consumer's custom
18 +# portal page uses classes the shipped CSS was not purged against.
19 +rebuild-assets = ["dep:flate2"]
20 +
21 +[dependencies]
22 +log = "0.4"
23 +anyhow = "1"
24 +serde = { version = "1", features = ["derive"] }
25 +serde_json = "1"
26 +
27 +# esp-idf-svc is deliberately target-scoped so that `cargo test` on the host
28 +# compiles the pure modules (form parsing, DNS reply building, config
29 +# fragments) without an ESP toolchain. Everything that needs the ESP-IDF is
30 +# behind `#[cfg(target_os = "espidf")]` in lib.rs.
31 +#
32 +# NOTE: no `[patch.crates-io]` here on purpose. Patches only apply from the
33 +# root manifest, so each consuming binary decides whether esp-idf-* resolves to
34 +# crates.io or to git master. See README "Version skew".
35 +#
36 +# `default-features = false` + `std` on purpose: the default set includes
37 +# `binstart`, which defines the binary entry point. That is the consuming
38 +# *binary's* choice (it may want `libstart` instead), not a library's to force.
39 +# `std` implies `alloc`.
40 +[target.'cfg(target_os = "espidf")'.dependencies]
41 +esp-idf-svc = { version = "0.52", default-features = false, features = ["std"] }
42 +
43 +[build-dependencies]
44 +flate2 = { version = "1", optional = true }
45 +
46 +[dev-dependencies]
47 +serde_json = "1"
added LICENSE.md
+675 −0
@@ -0,0 +1,675 @@
1 +# GNU GENERAL PUBLIC LICENSE
2 +
3 +Version 3, 29 June 2007
4 +
5 +Copyright (C) 2007 Free Software Foundation, Inc.
6 +<https://fsf.org/>
7 +
8 +Everyone is permitted to copy and distribute verbatim copies of this
9 +license document, but changing it is not allowed.
10 +
11 +## Preamble
12 +
13 +The GNU General Public License is a free, copyleft license for
14 +software and other kinds of works.
15 +
16 +The licenses for most software and other practical works are designed
17 +to take away your freedom to share and change the works. By contrast,
18 +the GNU General Public License is intended to guarantee your freedom
19 +to share and change all versions of a program--to make sure it remains
20 +free software for all its users. We, the Free Software Foundation, use
21 +the GNU General Public License for most of our software; it applies
22 +also to any other work released this way by its authors. You can apply
23 +it to your programs, too.
24 +
25 +When we speak of free software, we are referring to freedom, not
26 +price. Our General Public Licenses are designed to make sure that you
27 +have the freedom to distribute copies of free software (and charge for
28 +them if you wish), that you receive source code or can get it if you
29 +want it, that you can change the software or use pieces of it in new
30 +free programs, and that you know you can do these things.
31 +
32 +To protect your rights, we need to prevent others from denying you
33 +these rights or asking you to surrender the rights. Therefore, you
34 +have certain responsibilities if you distribute copies of the
35 +software, or if you modify it: responsibilities to respect the freedom
36 +of others.
37 +
38 +For example, if you distribute copies of such a program, whether
39 +gratis or for a fee, you must pass on to the recipients the same
40 +freedoms that you received. You must make sure that they, too, receive
41 +or can get the source code. And you must show them these terms so they
42 +know their rights.
43 +
44 +Developers that use the GNU GPL protect your rights with two steps:
45 +(1) assert copyright on the software, and (2) offer you this License
46 +giving you legal permission to copy, distribute and/or modify it.
47 +
48 +For the developers' and authors' protection, the GPL clearly explains
49 +that there is no warranty for this free software. For both users' and
50 +authors' sake, the GPL requires that modified versions be marked as
51 +changed, so that their problems will not be attributed erroneously to
52 +authors of previous versions.
53 +
54 +Some devices are designed to deny users access to install or run
55 +modified versions of the software inside them, although the
56 +manufacturer can do so. This is fundamentally incompatible with the
57 +aim of protecting users' freedom to change the software. The
58 +systematic pattern of such abuse occurs in the area of products for
59 +individuals to use, which is precisely where it is most unacceptable.
60 +Therefore, we have designed this version of the GPL to prohibit the
61 +practice for those products. If such problems arise substantially in
62 +other domains, we stand ready to extend this provision to those
63 +domains in future versions of the GPL, as needed to protect the
64 +freedom of users.
65 +
66 +Finally, every program is threatened constantly by software patents.
67 +States should not allow patents to restrict development and use of
68 +software on general-purpose computers, but in those that do, we wish
69 +to avoid the special danger that patents applied to a free program
70 +could make it effectively proprietary. To prevent this, the GPL
71 +assures that patents cannot be used to render the program non-free.
72 +
73 +The precise terms and conditions for copying, distribution and
74 +modification follow.
75 +
76 +## TERMS AND CONDITIONS
77 +
78 +### 0. Definitions.
79 +
80 +"This License" refers to version 3 of the GNU General Public License.
81 +
82 +"Copyright" also means copyright-like laws that apply to other kinds
83 +of works, such as semiconductor masks.
84 +
85 +"The Program" refers to any copyrightable work licensed under this
86 +License. Each licensee is addressed as "you". "Licensees" and
87 +"recipients" may be individuals or organizations.
88 +
89 +To "modify" a work means to copy from or adapt all or part of the work
90 +in a fashion requiring copyright permission, other than the making of
91 +an exact copy. The resulting work is called a "modified version" of
92 +the earlier work or a work "based on" the earlier work.
93 +
94 +A "covered work" means either the unmodified Program or a work based
95 +on the Program.
96 +
97 +To "propagate" a work means to do anything with it that, without
98 +permission, would make you directly or secondarily liable for
99 +infringement under applicable copyright law, except executing it on a
100 +computer or modifying a private copy. Propagation includes copying,
101 +distribution (with or without modification), making available to the
102 +public, and in some countries other activities as well.
103 +
104 +To "convey" a work means any kind of propagation that enables other
105 +parties to make or receive copies. Mere interaction with a user
106 +through a computer network, with no transfer of a copy, is not
107 +conveying.
108 +
109 +An interactive user interface displays "Appropriate Legal Notices" to
110 +the extent that it includes a convenient and prominently visible
111 +feature that (1) displays an appropriate copyright notice, and (2)
112 +tells the user that there is no warranty for the work (except to the
113 +extent that warranties are provided), that licensees may convey the
114 +work under this License, and how to view a copy of this License. If
115 +the interface presents a list of user commands or options, such as a
116 +menu, a prominent item in the list meets this criterion.
117 +
118 +### 1. Source Code.
119 +
120 +The "source code" for a work means the preferred form of the work for
121 +making modifications to it. "Object code" means any non-source form of
122 +a work.
123 +
124 +A "Standard Interface" means an interface that either is an official
125 +standard defined by a recognized standards body, or, in the case of
126 +interfaces specified for a particular programming language, one that
127 +is widely used among developers working in that language.
128 +
129 +The "System Libraries" of an executable work include anything, other
130 +than the work as a whole, that (a) is included in the normal form of
131 +packaging a Major Component, but which is not part of that Major
132 +Component, and (b) serves only to enable use of the work with that
133 +Major Component, or to implement a Standard Interface for which an
134 +implementation is available to the public in source code form. A
135 +"Major Component", in this context, means a major essential component
136 +(kernel, window system, and so on) of the specific operating system
137 +(if any) on which the executable work runs, or a compiler used to
138 +produce the work, or an object code interpreter used to run it.
139 +
140 +The "Corresponding Source" for a work in object code form means all
141 +the source code needed to generate, install, and (for an executable
142 +work) run the object code and to modify the work, including scripts to
143 +control those activities. However, it does not include the work's
144 +System Libraries, or general-purpose tools or generally available free
145 +programs which are used unmodified in performing those activities but
146 +which are not part of the work. For example, Corresponding Source
147 +includes interface definition files associated with source files for
148 +the work, and the source code for shared libraries and dynamically
149 +linked subprograms that the work is specifically designed to require,
150 +such as by intimate data communication or control flow between those
151 +subprograms and other parts of the work.
152 +
153 +The Corresponding Source need not include anything that users can
154 +regenerate automatically from other parts of the Corresponding Source.
155 +
156 +The Corresponding Source for a work in source code form is that same
157 +work.
158 +
159 +### 2. Basic Permissions.
160 +
161 +All rights granted under this License are granted for the term of
162 +copyright on the Program, and are irrevocable provided the stated
163 +conditions are met. This License explicitly affirms your unlimited
164 +permission to run the unmodified Program. The output from running a
165 +covered work is covered by this License only if the output, given its
166 +content, constitutes a covered work. This License acknowledges your
167 +rights of fair use or other equivalent, as provided by copyright law.
168 +
169 +You may make, run and propagate covered works that you do not convey,
170 +without conditions so long as your license otherwise remains in force.
171 +You may convey covered works to others for the sole purpose of having
172 +them make modifications exclusively for you, or provide you with
173 +facilities for running those works, provided that you comply with the
174 +terms of this License in conveying all material for which you do not
175 +control copyright. Those thus making or running the covered works for
176 +you must do so exclusively on your behalf, under your direction and
177 +control, on terms that prohibit them from making any copies of your
178 +copyrighted material outside their relationship with you.
179 +
180 +Conveying under any other circumstances is permitted solely under the
181 +conditions stated below. Sublicensing is not allowed; section 10 makes
182 +it unnecessary.
183 +
184 +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
185 +
186 +No covered work shall be deemed part of an effective technological
187 +measure under any applicable law fulfilling obligations under article
188 +11 of the WIPO copyright treaty adopted on 20 December 1996, or
189 +similar laws prohibiting or restricting circumvention of such
190 +measures.
191 +
192 +When you convey a covered work, you waive any legal power to forbid
193 +circumvention of technological measures to the extent such
194 +circumvention is effected by exercising rights under this License with
195 +respect to the covered work, and you disclaim any intention to limit
196 +operation or modification of the work as a means of enforcing, against
197 +the work's users, your or third parties' legal rights to forbid
198 +circumvention of technological measures.
199 +
200 +### 4. Conveying Verbatim Copies.
201 +
202 +You may convey verbatim copies of the Program's source code as you
203 +receive it, in any medium, provided that you conspicuously and
204 +appropriately publish on each copy an appropriate copyright notice;
205 +keep intact all notices stating that this License and any
206 +non-permissive terms added in accord with section 7 apply to the code;
207 +keep intact all notices of the absence of any warranty; and give all
208 +recipients a copy of this License along with the Program.
209 +
210 +You may charge any price or no price for each copy that you convey,
211 +and you may offer support or warranty protection for a fee.
212 +
213 +### 5. Conveying Modified Source Versions.
214 +
215 +You may convey a work based on the Program, or the modifications to
216 +produce it from the Program, in the form of source code under the
217 +terms of section 4, provided that you also meet all of these
218 +conditions:
219 +
220 +- a) The work must carry prominent notices stating that you modified
221 + it, and giving a relevant date.
222 +- b) The work must carry prominent notices stating that it is
223 + released under this License and any conditions added under
224 + section 7. This requirement modifies the requirement in section 4
225 + to "keep intact all notices".
226 +- c) You must license the entire work, as a whole, under this
227 + License to anyone who comes into possession of a copy. This
228 + License will therefore apply, along with any applicable section 7
229 + additional terms, to the whole of the work, and all its parts,
230 + regardless of how they are packaged. This License gives no
231 + permission to license the work in any other way, but it does not
232 + invalidate such permission if you have separately received it.
233 +- d) If the work has interactive user interfaces, each must display
234 + Appropriate Legal Notices; however, if the Program has interactive
235 + interfaces that do not display Appropriate Legal Notices, your
236 + work need not make them do so.
237 +
238 +A compilation of a covered work with other separate and independent
239 +works, which are not by their nature extensions of the covered work,
240 +and which are not combined with it such as to form a larger program,
241 +in or on a volume of a storage or distribution medium, is called an
242 +"aggregate" if the compilation and its resulting copyright are not
243 +used to limit the access or legal rights of the compilation's users
244 +beyond what the individual works permit. Inclusion of a covered work
245 +in an aggregate does not cause this License to apply to the other
246 +parts of the aggregate.
247 +
248 +### 6. Conveying Non-Source Forms.
249 +
250 +You may convey a covered work in object code form under the terms of
251 +sections 4 and 5, provided that you also convey the machine-readable
252 +Corresponding Source under the terms of this License, in one of these
253 +ways:
254 +
255 +- a) Convey the object code in, or embodied in, a physical product
256 + (including a physical distribution medium), accompanied by the
257 + Corresponding Source fixed on a durable physical medium
258 + customarily used for software interchange.
259 +- b) Convey the object code in, or embodied in, a physical product
260 + (including a physical distribution medium), accompanied by a
261 + written offer, valid for at least three years and valid for as
262 + long as you offer spare parts or customer support for that product
263 + model, to give anyone who possesses the object code either (1) a
264 + copy of the Corresponding Source for all the software in the
265 + product that is covered by this License, on a durable physical
266 + medium customarily used for software interchange, for a price no
267 + more than your reasonable cost of physically performing this
268 + conveying of source, or (2) access to copy the Corresponding
269 + Source from a network server at no charge.
270 +- c) Convey individual copies of the object code with a copy of the
271 + written offer to provide the Corresponding Source. This
272 + alternative is allowed only occasionally and noncommercially, and
273 + only if you received the object code with such an offer, in accord
274 + with subsection 6b.
275 +- d) Convey the object code by offering access from a designated
276 + place (gratis or for a charge), and offer equivalent access to the
277 + Corresponding Source in the same way through the same place at no
278 + further charge. You need not require recipients to copy the
279 + Corresponding Source along with the object code. If the place to
280 + copy the object code is a network server, the Corresponding Source
281 + may be on a different server (operated by you or a third party)
282 + that supports equivalent copying facilities, provided you maintain
283 + clear directions next to the object code saying where to find the
284 + Corresponding Source. Regardless of what server hosts the
285 + Corresponding Source, you remain obligated to ensure that it is
286 + available for as long as needed to satisfy these requirements.
287 +- e) Convey the object code using peer-to-peer transmission,
288 + provided you inform other peers where the object code and
289 + Corresponding Source of the work are being offered to the general
290 + public at no charge under subsection 6d.
291 +
292 +A separable portion of the object code, whose source code is excluded
293 +from the Corresponding Source as a System Library, need not be
294 +included in conveying the object code work.
295 +
296 +A "User Product" is either (1) a "consumer product", which means any
297 +tangible personal property which is normally used for personal,
298 +family, or household purposes, or (2) anything designed or sold for
299 +incorporation into a dwelling. In determining whether a product is a
300 +consumer product, doubtful cases shall be resolved in favor of
301 +coverage. For a particular product received by a particular user,
302 +"normally used" refers to a typical or common use of that class of
303 +product, regardless of the status of the particular user or of the way
304 +in which the particular user actually uses, or expects or is expected
305 +to use, the product. A product is a consumer product regardless of
306 +whether the product has substantial commercial, industrial or
307 +non-consumer uses, unless such uses represent the only significant
308 +mode of use of the product.
309 +
310 +"Installation Information" for a User Product means any methods,
311 +procedures, authorization keys, or other information required to
312 +install and execute modified versions of a covered work in that User
313 +Product from a modified version of its Corresponding Source. The
314 +information must suffice to ensure that the continued functioning of
315 +the modified object code is in no case prevented or interfered with
316 +solely because modification has been made.
317 +
318 +If you convey an object code work under this section in, or with, or
319 +specifically for use in, a User Product, and the conveying occurs as
320 +part of a transaction in which the right of possession and use of the
321 +User Product is transferred to the recipient in perpetuity or for a
322 +fixed term (regardless of how the transaction is characterized), the
323 +Corresponding Source conveyed under this section must be accompanied
324 +by the Installation Information. But this requirement does not apply
325 +if neither you nor any third party retains the ability to install
326 +modified object code on the User Product (for example, the work has
327 +been installed in ROM).
328 +
329 +The requirement to provide Installation Information does not include a
330 +requirement to continue to provide support service, warranty, or
331 +updates for a work that has been modified or installed by the
332 +recipient, or for the User Product in which it has been modified or
333 +installed. Access to a network may be denied when the modification
334 +itself materially and adversely affects the operation of the network
335 +or violates the rules and protocols for communication across the
336 +network.
337 +
338 +Corresponding Source conveyed, and Installation Information provided,
339 +in accord with this section must be in a format that is publicly
340 +documented (and with an implementation available to the public in
341 +source code form), and must require no special password or key for
342 +unpacking, reading or copying.
343 +
344 +### 7. Additional Terms.
345 +
346 +"Additional permissions" are terms that supplement the terms of this
347 +License by making exceptions from one or more of its conditions.
348 +Additional permissions that are applicable to the entire Program shall
349 +be treated as though they were included in this License, to the extent
350 +that they are valid under applicable law. If additional permissions
351 +apply only to part of the Program, that part may be used separately
352 +under those permissions, but the entire Program remains governed by
353 +this License without regard to the additional permissions.
354 +
355 +When you convey a copy of a covered work, you may at your option
356 +remove any additional permissions from that copy, or from any part of
357 +it. (Additional permissions may be written to require their own
358 +removal in certain cases when you modify the work.) You may place
359 +additional permissions on material, added by you to a covered work,
360 +for which you have or can give appropriate copyright permission.
361 +
362 +Notwithstanding any other provision of this License, for material you
363 +add to a covered work, you may (if authorized by the copyright holders
364 +of that material) supplement the terms of this License with terms:
365 +
366 +- a) Disclaiming warranty or limiting liability differently from the
367 + terms of sections 15 and 16 of this License; or
368 +- b) Requiring preservation of specified reasonable legal notices or
369 + author attributions in that material or in the Appropriate Legal
370 + Notices displayed by works containing it; or
371 +- c) Prohibiting misrepresentation of the origin of that material,
372 + or requiring that modified versions of such material be marked in
373 + reasonable ways as different from the original version; or
374 +- d) Limiting the use for publicity purposes of names of licensors
375 + or authors of the material; or
376 +- e) Declining to grant rights under trademark law for use of some
377 + trade names, trademarks, or service marks; or
378 +- f) Requiring indemnification of licensors and authors of that
379 + material by anyone who conveys the material (or modified versions
380 + of it) with contractual assumptions of liability to the recipient,
381 + for any liability that these contractual assumptions directly
382 + impose on those licensors and authors.
383 +
384 +All other non-permissive additional terms are considered "further
385 +restrictions" within the meaning of section 10. If the Program as you
386 +received it, or any part of it, contains a notice stating that it is
387 +governed by this License along with a term that is a further
388 +restriction, you may remove that term. If a license document contains
389 +a further restriction but permits relicensing or conveying under this
390 +License, you may add to a covered work material governed by the terms
391 +of that license document, provided that the further restriction does
392 +not survive such relicensing or conveying.
393 +
394 +If you add terms to a covered work in accord with this section, you
395 +must place, in the relevant source files, a statement of the
396 +additional terms that apply to those files, or a notice indicating
397 +where to find the applicable terms.
398 +
399 +Additional terms, permissive or non-permissive, may be stated in the
400 +form of a separately written license, or stated as exceptions; the
401 +above requirements apply either way.
402 +
403 +### 8. Termination.
404 +
405 +You may not propagate or modify a covered work except as expressly
406 +provided under this License. Any attempt otherwise to propagate or
407 +modify it is void, and will automatically terminate your rights under
408 +this License (including any patent licenses granted under the third
409 +paragraph of section 11).
410 +
411 +However, if you cease all violation of this License, then your license
412 +from a particular copyright holder is reinstated (a) provisionally,
413 +unless and until the copyright holder explicitly and finally
414 +terminates your license, and (b) permanently, if the copyright holder
415 +fails to notify you of the violation by some reasonable means prior to
416 +60 days after the cessation.
417 +
418 +Moreover, your license from a particular copyright holder is
419 +reinstated permanently if the copyright holder notifies you of the
420 +violation by some reasonable means, this is the first time you have
421 +received notice of violation of this License (for any work) from that
422 +copyright holder, and you cure the violation prior to 30 days after
423 +your receipt of the notice.
424 +
425 +Termination of your rights under this section does not terminate the
426 +licenses of parties who have received copies or rights from you under
427 +this License. If your rights have been terminated and not permanently
428 +reinstated, you do not qualify to receive new licenses for the same
429 +material under section 10.
430 +
431 +### 9. Acceptance Not Required for Having Copies.
432 +
433 +You are not required to accept this License in order to receive or run
434 +a copy of the Program. Ancillary propagation of a covered work
435 +occurring solely as a consequence of using peer-to-peer transmission
436 +to receive a copy likewise does not require acceptance. However,
437 +nothing other than this License grants you permission to propagate or
438 +modify any covered work. These actions infringe copyright if you do
439 +not accept this License. Therefore, by modifying or propagating a
440 +covered work, you indicate your acceptance of this License to do so.
441 +
442 +### 10. Automatic Licensing of Downstream Recipients.
443 +
444 +Each time you convey a covered work, the recipient automatically
445 +receives a license from the original licensors, to run, modify and
446 +propagate that work, subject to this License. You are not responsible
447 +for enforcing compliance by third parties with this License.
448 +
449 +An "entity transaction" is a transaction transferring control of an
450 +organization, or substantially all assets of one, or subdividing an
451 +organization, or merging organizations. If propagation of a covered
452 +work results from an entity transaction, each party to that
453 +transaction who receives a copy of the work also receives whatever
454 +licenses to the work the party's predecessor in interest had or could
455 +give under the previous paragraph, plus a right to possession of the
456 +Corresponding Source of the work from the predecessor in interest, if
457 +the predecessor has it or can get it with reasonable efforts.
458 +
459 +You may not impose any further restrictions on the exercise of the
460 +rights granted or affirmed under this License. For example, you may
461 +not impose a license fee, royalty, or other charge for exercise of
462 +rights granted under this License, and you may not initiate litigation
463 +(including a cross-claim or counterclaim in a lawsuit) alleging that
464 +any patent claim is infringed by making, using, selling, offering for
465 +sale, or importing the Program or any portion of it.
466 +
467 +### 11. Patents.
468 +
469 +A "contributor" is a copyright holder who authorizes use under this
470 +License of the Program or a work on which the Program is based. The
471 +work thus licensed is called the contributor's "contributor version".
472 +
473 +A contributor's "essential patent claims" are all patent claims owned
474 +or controlled by the contributor, whether already acquired or
475 +hereafter acquired, that would be infringed by some manner, permitted
476 +by this License, of making, using, or selling its contributor version,
477 +but do not include claims that would be infringed only as a
478 +consequence of further modification of the contributor version. For
479 +purposes of this definition, "control" includes the right to grant
480 +patent sublicenses in a manner consistent with the requirements of
481 +this License.
482 +
483 +Each contributor grants you a non-exclusive, worldwide, royalty-free
484 +patent license under the contributor's essential patent claims, to
485 +make, use, sell, offer for sale, import and otherwise run, modify and
486 +propagate the contents of its contributor version.
487 +
488 +In the following three paragraphs, a "patent license" is any express
489 +agreement or commitment, however denominated, not to enforce a patent
490 +(such as an express permission to practice a patent or covenant not to
491 +sue for patent infringement). To "grant" such a patent license to a
492 +party means to make such an agreement or commitment not to enforce a
493 +patent against the party.
494 +
495 +If you convey a covered work, knowingly relying on a patent license,
496 +and the Corresponding Source of the work is not available for anyone
497 +to copy, free of charge and under the terms of this License, through a
498 +publicly available network server or other readily accessible means,
499 +then you must either (1) cause the Corresponding Source to be so
500 +available, or (2) arrange to deprive yourself of the benefit of the
501 +patent license for this particular work, or (3) arrange, in a manner
502 +consistent with the requirements of this License, to extend the patent
503 +license to downstream recipients. "Knowingly relying" means you have
504 +actual knowledge that, but for the patent license, your conveying the
505 +covered work in a country, or your recipient's use of the covered work
506 +in a country, would infringe one or more identifiable patents in that
507 +country that you have reason to believe are valid.
508 +
509 +If, pursuant to or in connection with a single transaction or
510 +arrangement, you convey, or propagate by procuring conveyance of, a
511 +covered work, and grant a patent license to some of the parties
512 +receiving the covered work authorizing them to use, propagate, modify
513 +or convey a specific copy of the covered work, then the patent license
514 +you grant is automatically extended to all recipients of the covered
515 +work and works based on it.
516 +
517 +A patent license is "discriminatory" if it does not include within the
518 +scope of its coverage, prohibits the exercise of, or is conditioned on
519 +the non-exercise of one or more of the rights that are specifically
520 +granted under this License. You may not convey a covered work if you
521 +are a party to an arrangement with a third party that is in the
522 +business of distributing software, under which you make payment to the
523 +third party based on the extent of your activity of conveying the
524 +work, and under which the third party grants, to any of the parties
525 +who would receive the covered work from you, a discriminatory patent
526 +license (a) in connection with copies of the covered work conveyed by
527 +you (or copies made from those copies), or (b) primarily for and in
528 +connection with specific products or compilations that contain the
529 +covered work, unless you entered into that arrangement, or that patent
530 +license was granted, prior to 28 March 2007.
531 +
532 +Nothing in this License shall be construed as excluding or limiting
533 +any implied license or other defenses to infringement that may
534 +otherwise be available to you under applicable patent law.
535 +
536 +### 12. No Surrender of Others' Freedom.
537 +
538 +If conditions are imposed on you (whether by court order, agreement or
539 +otherwise) that contradict the conditions of this License, they do not
540 +excuse you from the conditions of this License. If you cannot convey a
541 +covered work so as to satisfy simultaneously your obligations under
542 +this License and any other pertinent obligations, then as a
543 +consequence you may not convey it at all. For example, if you agree to
544 +terms that obligate you to collect a royalty for further conveying
545 +from those to whom you convey the Program, the only way you could
546 +satisfy both those terms and this License would be to refrain entirely
547 +from conveying the Program.
548 +
549 +### 13. Use with the GNU Affero General Public License.
550 +
551 +Notwithstanding any other provision of this License, you have
552 +permission to link or combine any covered work with a work licensed
553 +under version 3 of the GNU Affero General Public License into a single
554 +combined work, and to convey the resulting work. The terms of this
555 +License will continue to apply to the part which is the covered work,
556 +but the special requirements of the GNU Affero General Public License,
557 +section 13, concerning interaction through a network will apply to the
558 +combination as such.
559 +
560 +### 14. Revised Versions of this License.
561 +
562 +The Free Software Foundation may publish revised and/or new versions
563 +of the GNU General Public License from time to time. Such new versions
564 +will be similar in spirit to the present version, but may differ in
565 +detail to address new problems or concerns.
566 +
567 +Each version is given a distinguishing version number. If the Program
568 +specifies that a certain numbered version of the GNU General Public
569 +License "or any later version" applies to it, you have the option of
570 +following the terms and conditions either of that numbered version or
571 +of any later version published by the Free Software Foundation. If the
572 +Program does not specify a version number of the GNU General Public
573 +License, you may choose any version ever published by the Free
574 +Software Foundation.
575 +
576 +If the Program specifies that a proxy can decide which future versions
577 +of the GNU General Public License can be used, that proxy's public
578 +statement of acceptance of a version permanently authorizes you to
579 +choose that version for the Program.
580 +
581 +Later license versions may give you additional or different
582 +permissions. However, no additional obligations are imposed on any
583 +author or copyright holder as a result of your choosing to follow a
584 +later version.
585 +
586 +### 15. Disclaimer of Warranty.
587 +
588 +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
589 +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
590 +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
591 +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
592 +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
593 +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
594 +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
595 +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
596 +CORRECTION.
597 +
598 +### 16. Limitation of Liability.
599 +
600 +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
602 +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
603 +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
604 +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
605 +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
606 +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
607 +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
608 +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
609 +
610 +### 17. Interpretation of Sections 15 and 16.
611 +
612 +If the disclaimer of warranty and limitation of liability provided
613 +above cannot be given local legal effect according to their terms,
614 +reviewing courts shall apply local law that most closely approximates
615 +an absolute waiver of all civil liability in connection with the
616 +Program, unless a warranty or assumption of liability accompanies a
617 +copy of the Program in return for a fee.
618 +
619 +END OF TERMS AND CONDITIONS
620 +
621 +## How to Apply These Terms to Your New Programs
622 +
623 +If you develop a new program, and you want it to be of the greatest
624 +possible use to the public, the best way to achieve this is to make it
625 +free software which everyone can redistribute and change under these
626 +terms.
627 +
628 +To do so, attach the following notices to the program. It is safest to
629 +attach them to the start of each source file to most effectively state
630 +the exclusion of warranty; and each file should have at least the
631 +"copyright" line and a pointer to where the full notice is found.
632 +
633 + <one line to give the program's name and a brief idea of what it does.>
634 + Copyright (C) <year> <name of author>
635 +
636 + This program is free software: you can redistribute it and/or modify
637 + it under the terms of the GNU General Public License as published by
638 + the Free Software Foundation, either version 3 of the License, or
639 + (at your option) any later version.
640 +
641 + This program is distributed in the hope that it will be useful,
642 + but WITHOUT ANY WARRANTY; without even the implied warranty of
643 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
644 + GNU General Public License for more details.
645 +
646 + You should have received a copy of the GNU General Public License
647 + along with this program. If not, see <https://www.gnu.org/licenses/>.
648 +
649 +Also add information on how to contact you by electronic and paper
650 +mail.
651 +
652 +If the program does terminal interaction, make it output a short
653 +notice like this when it starts in an interactive mode:
654 +
655 + <program> Copyright (C) <year> <name of author>
656 + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 + This is free software, and you are welcome to redistribute it
658 + under certain conditions; type `show c' for details.
659 +
660 +The hypothetical commands \`show w' and \`show c' should show the
661 +appropriate parts of the General Public License. Of course, your
662 +program's commands might be different; for a GUI interface, you would
663 +use an "about box".
664 +
665 +You should also get your employer (if you work as a programmer) or
666 +school, if any, to sign a "copyright disclaimer" for the program, if
667 +necessary. For more information on this, and how to apply and follow
668 +the GNU GPL, see <https://www.gnu.org/licenses/>.
669 +
670 +The GNU General Public License does not permit incorporating your
671 +program into proprietary programs. If your program is a subroutine
672 +library, you may consider it more useful to permit linking proprietary
673 +applications with the library. If this is what you want to do, use the
674 +GNU Lesser General Public License instead of this License. But first,
675 +please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
added README.md
+250 −0
@@ -0,0 +1,250 @@
1 +# neiam-portal
2 +
3 +Captive-portal provisioning and status web UI for ESP32 firmware, on
4 +`esp-idf-svc` (std / ESP-IDF, not bare-metal).
5 +
6 +Extracted from [`nfc-522`](../nfc-522) so the same setup flow can be reused
7 +across devices. The crate owns the *mechanism* — SoftAP, captive DNS, the
8 +config form, NVS persistence, gzipped asset serving — while each firmware
9 +supplies its own config schema and status payload.
10 +
11 +## What you get
12 +
13 +| | |
14 +|---|---|
15 +| `provision::run` | SoftAP + captive DNS + config form, reboots once saved |
16 +| `portal::start` | just the provisioning HTTP server |
17 +| `StatusServer` | read-only status page + JSON endpoints over the station IP |
18 +| `ConfigStore` | NVS JSON blob load/save, plus the boot-failure counter |
19 +| `wifi::connect_sta` / `start_ap` | WiFi bring-up |
20 +| `wifi::keep_connected` | re-associates when the AP drops the station |
21 +| `Form` | urlencoded body parsing |
22 +| `dns::serve` | captive DNS that points every A query at the AP |
23 +
24 +Roughly 53 KB of flash for the whole web UI (gzipped CSS + two pages + two
25 +woff2 subsets).
26 +
27 +## The config contract
28 +
29 +The crate is generic over your config type. Embed the fragments you want with
30 +`#[serde(flatten)]` and implement `PortalConfig`:
31 +
32 +```rust
33 +use neiam_portal::{Form, PortalConfig, WifiConfig};
34 +use serde::{Deserialize, Serialize};
35 +
36 +#[derive(Serialize, Deserialize, Clone, Default)]
37 +struct Config {
38 + #[serde(flatten)]
39 + wifi: WifiConfig,
40 + #[serde(default)]
41 + udp_start: u16,
42 +}
43 +
44 +impl PortalConfig for Config {
45 + fn from_form(f: &Form) -> Self {
46 + Self {
47 + wifi: WifiConfig::from_form(f),
48 + udp_start: f.parsed_or("udp_start", 7777),
49 + }
50 + }
51 + fn wifi(&self) -> &WifiConfig { &self.wifi }
52 +}
53 +```
54 +
55 +`flatten` keeps the stored JSON flat (`{"wifi_ssid":…,"udp_start":…}`), which
56 +is byte-compatible with the blobs `nfc-522` wrote before the extraction —
57 +devices in the field keep their config across the upgrade.
58 +
59 +Then at boot:
60 +
61 +```rust
62 +let store = ConfigStore::new(nvs);
63 +let cfg: Config = store.load();
64 +if !cfg.is_provisioned() {
65 + provision::run::<Config, _>(modem, sysloop, store, &ssid, Pages::default())?;
66 + // never returns; reboots once the user submits
67 +}
68 +```
69 +
70 +## More than one network
71 +
72 +`WifiConfig` carries a primary network plus up to two alternates
73 +(`MAX_NETWORKS`), so a device that moves between a bench AP and where it
74 +actually lives does not have to be re-provisioned in between. The portal form
75 +has two optional extra rows; they arrive as `wifi_ssid_2`/`wifi_pass_2` and
76 +`wifi_ssid_3`/`wifi_pass_3` and land in `WifiConfig::wifi_alts`.
77 +
78 +The stored blob is unchanged for a device with one network: `wifi_alts` is
79 +skipped when empty, so blobs written before this existed load as they did and
80 +new ones are byte-identical until an alternate is actually set.
81 +
82 +Bring-up starts the radio, scans, and tries the known SSIDs **loudest first**
83 +— which is what makes a device carried between two of its own networks land on
84 +the nearer one rather than on whichever was typed in first. Networks the scan
85 +did not see are still tried afterwards in config order, since a hidden SSID
86 +never shows up in a scan. If the scan itself fails the whole list is tried in
87 +order.
88 +
89 +The choice is made once, at bring-up: `keep_connected` re-associates to the
90 +network that was chosen and does not re-scan. Reaching a different one means a
91 +reboot, which is what a consumer already does when the link stays down.
92 +
93 +## Staying connected
94 +
95 +`connect_sta`/`connect_sta_blocking` associate **once**, to one network. Nothing in
96 +`esp-idf-svc`, and nothing in ESP-IDF's station config, reconnects when the AP
97 +later drops you — so any device meant to run for longer than an afternoon wants
98 +`wifi::keep_connected` as well:
99 +
100 +```rust
101 +let wifi = wifi::connect_sta_blocking(modem, sysloop.clone(), nvs, cfg.wifi())?;
102 +wifi::disable_power_save()?;
103 +let _reconnect = wifi::keep_connected(&sysloop)?; // hold this
104 +```
105 +
106 +Two things to get right. Call it **after** the initial connect — those calls
107 +wait on the same events and a handler calling `esp_wifi_connect` underneath
108 +them races both — and **keep the returned subscription alive**, since dropping
109 +it unregisters the handler and the station goes back to staying down.
110 +
111 +It also logs the disconnect reason, which is carried nowhere else: 201 is
112 +`NO_AP_FOUND`, 15 a handshake timeout (very nearly always the passphrase), 205
113 +a connection made and lost.
114 +
115 +How the omission shows up depends on the device. One that dials out logs
116 +`Host is unreachable` from every retry forever; one that only listens on a
117 +socket goes quiet with nothing in the log at all, which is harder to find.
118 +
119 +## Hostname
120 +
121 +A device with no hostname reports ESP-IDF's `CONFIG_LWIP_LOCAL_HOSTNAME`
122 +default, **`espressif`**, in DHCP — so a router's client list shows every ESP32
123 +on the LAN under the same name. Pass one to the `_named` variant instead:
124 +
125 +```rust
126 +let name = format!("lambent-flex-{}", neiam_portal::device_id()); // -> lambent-flex-0a1b2c
127 +let wifi = wifi::connect_sta_blocking_named(modem, sysloop.clone(), nvs, cfg.wifi(), Some(&name))?;
128 +```
129 +
130 +`connect_sta_named` is the async counterpart; the plain `connect_sta` /
131 +`connect_sta_blocking` are unchanged and delegate with `None`.
132 +
133 +The name has to be set inside the helper, not by the caller afterwards: lwip
134 +puts it in the DHCP DISCOVER as soon as the link comes up, so `wifi::set_hostname`
135 +(public, if you are driving `EspWifi` yourself) belongs after `EspWifi::new` —
136 +before that there is no `struct netif` and it fails with
137 +`ESP_ERR_ESP_NETIF_IF_NOT_READY` — and before `start()`. Max 32 bytes
138 +(`HOSTNAME_MAX_LEN`); over-long is an error, not a truncation.
139 +
140 +This is DHCP only. There is no mDNS responder here, so `<name>.local` resolves
141 +only if the router serves DNS from its leases.
142 +
143 +## Compile-time credentials (skipping the portal)
144 +
145 +Re-provisioning through a captive portal on every dev flash is miserable, so
146 +`ConfigStore::load_or_seed` takes an optional compile-time config:
147 +
148 +```rust
149 +let cfg: DeviceConfig = store.load_or_seed(cfg_toml_seed());
150 +```
151 +
152 +The seed applies **only to an unprovisioned device**, and is written to NVS on
153 +first use. Once anything is stored — seeded or submitted through the portal —
154 +NVS wins and the seed is ignored, so editing it and reflashing will *not* move
155 +an already-provisioned device (erase NVS to re-seed). The alternative, letting
156 +a stale compile-time value silently override what someone configured on the
157 +device, is the worse failure. A seed that isn't itself `is_provisioned()` is
158 +ignored, so an empty `cfg.toml` leaves the portal to do its job.
159 +
160 +The crate takes **no `toml-cfg` dependency** — where the seed comes from is the
161 +consumer's business. `lambent-flex-c6` wires it to `cfg.toml` behind its own
162 +default-on `cfg-toml` feature; see its `cfg_toml_seed()`.
163 +
164 +## Features
165 +
166 +- **`mqtt`** — adds `MqttConfig` (host/port/credentials/TLS/topic root, with
167 + `url()` and `topic()` helpers) and switches the built-in portal page to the
168 + variant carrying the broker form section. Config only: it does not pull in or
169 + own an MQTT client, so a device can use these settings with whatever client
170 + it likes.
171 +- **`rebuild-assets`** — regenerate the CSS/HTML from `web/` with Tailwind at
172 + build time instead of using the pre-built bytes in `assets/`. Requires
173 + Node.js + npm (and network on the first run).
174 +
175 +**Assets are pre-built and checked into `assets/` by default**, so consuming
176 +firmware needs no JS toolchain at all. Reach for `rebuild-assets` when
177 +restyling, or when you ship a custom page using classes the shipped CSS was not
178 +purged against. To refresh the checked-in copies:
179 +
180 +```sh
181 +cargo build --features rebuild-assets
182 +cp target/debug/build/neiam-portal-*/out/{app.css.gz,saved.html.gz,status.html.gz} assets/
183 +# portal.html.gz is the feature-selected variant; regenerate both by hand:
184 +gzip -9 -n -c web/src/portal-wifi.html > assets/portal-wifi.html.gz
185 +gzip -9 -n -c web/src/portal-mqtt.html > assets/portal-mqtt.html.gz
186 +```
187 +
188 +`gzip -n` omits the timestamp so the committed bytes stay reproducible.
189 +
190 +## Custom pages
191 +
192 +`Pages { portal, saved }` and `StatusServer::new(page)` take `Asset`s, so
193 +shipping your own HTML is a pure-Rust override — gzip it in your build script
194 +and pass the bytes. No env-var protocol, no build.rs coupling:
195 +
196 +```rust
197 +const MY_PAGE: Asset = Asset {
198 + bytes: include_bytes!(concat!(env!("OUT_DIR"), "/my-status.html.gz")),
199 + headers: neiam_portal::assets::H_HTML_GZ,
200 +};
201 +```
202 +
203 +## Host testing
204 +
205 +`esp-idf-svc` is a **target-scoped** dependency, so `cargo test` on a normal
206 +host compiles and runs the pure modules with no ESP toolchain:
207 +
208 +```sh
209 +cargo test # 36 tests
210 +cargo test --features mqtt # 46 tests
211 +```
212 +
213 +Everything needing the ESP-IDF sits behind `#[cfg(target_os = "espidf")]`
214 +(`http`, `portal`, `provision`, `status`, `store`, `wifi`). Note the corollary:
215 +**host `cargo clippy` does not lint those modules** — only a real cross build does.
216 +
217 +## Version skew
218 +
219 +This crate deliberately declares **no `[patch.crates-io]`**. Patches only apply
220 +from the root manifest, so each consuming binary decides whether `esp-idf-*`
221 +resolves to crates.io or to git master. The two current consumers differ:
222 +
223 +| | nfc-522 | lambent-flex-c6 |
224 +|---|---|---|
225 +| `ESP_IDF_VERSION` | v5.5.3 | v5.2.3 |
226 +| esp-idf-svc | 0.52.1 patched to git master | 0.52.1 from crates.io |
227 +| MCU / target | esp32c3 / `riscv32imc` | esp32c6 / `riscv32imac` |
228 +
229 +The dependency is `esp-idf-svc = "0.52"` (permissive) for that reason. If the
230 +git-master API drifts far enough from released 0.52.1, one of the two consumers
231 +will stop building before the other — that is the expected failure mode, and
232 +the fix is to align the consumers, not to patch here.
233 +
234 +## Deliberate changes from the nfc-522 original
235 +
236 +Not a pure copy. Three behavioural fixes came along with the extraction:
237 +
238 +1. **Captive DNS answers non-A queries with an empty `NOERROR`.** The original
239 + replied to *every* query type — AAAA included — with a type-A answer record,
240 + which is malformed and can be discarded by a strict resolver.
241 +2. **`POST /save` rejects an over-long body with `413`** instead of silently
242 + truncating it and saving a partial config. The original checked the limit
243 + after appending, then parsed whatever it had.
244 +3. **`POST /save` rejects an incomplete config with `400`.** The original saved
245 + whatever was submitted and rebooted, so a half-filled form produced a device
246 + that came straight back to the portal with no explanation.
247 +
248 +Also: the checkbox rule is now explicit — `mqtt_use_tls=off` reads as `false`
249 +rather than as "present, therefore on" (the original needed a `tls_seen` flag
250 +to get the absent case right, and had no opinion about the value).
modified ?
+0 −0

Binary file — not rendered.

modified ?
+0 −0

Click to load diff…

modified ?
+0 −0

Click to load diff…

modified ?
+0 −0

Click to load diff…

modified ?
+0 −0

Click to load diff…

modified ?
+0 −0

Click to load diff…

modified ?
+0 −0

Click to load diff…

added build.rs
+165 −0

Click to load diff…

added src/assets.rs
+131 −0

Click to load diff…

added src/config.rs
+324 −0

Click to load diff…

added src/device_id.rs
+80 −0

Click to load diff…

added src/dns.rs
+244 −0

Click to load diff…

added src/form.rs
+222 −0

Click to load diff…

added src/http.rs
+39 −0

Click to load diff…

added src/lib.rs
+88 −0

Click to load diff…

added src/mqtt_config.rs
+280 −0

Click to load diff…

added src/portal.rs
+126 −0

Click to load diff…

added src/provision.rs
+65 −0

Click to load diff…

added src/status.rs
+86 −0

Click to load diff…

added src/store.rs
+163 −0

Click to load diff…

added src/wifi.rs
+475 −0

Click to load diff…

added web/input.css
+27 −0

Click to load diff…

added web/package-lock.json
+1031 −0

Click to load diff…

added web/package.json
+16 −0

Click to load diff…

added web/src/portal-mqtt.html
+181 −0

Click to load diff…

added web/src/portal-wifi.html
+128 −0

Click to load diff…

added web/src/saved.html
+36 −0

Click to load diff…

added web/src/status.html
+131 −0

Click to load diff…

added web/tailwind.config.js
+38 −0

Click to load diff…

Parents: