├── .gitignore
├── INSTALL.md
├── LICENSE
├── README.md
├── RUN.md
├── config
└── requirements.txt
├── docs
├── console_cable.md
├── details.md
└── images
│ ├── flow.png
│ ├── how-it-works.png
│ └── pi_zero_console_cable.png
├── nm_scripts
├── delete_all_wifi_connections.py
├── net-man-util.py
├── show_current_AP.py
├── start_dnsmasq.sh
└── start_hotspot.py
├── scripts
├── install.sh
├── optional_install_NetworkManager_on_Linux.sh
└── run.sh
├── src
├── dnsmasq.py
├── http_server.py
└── netman.py
└── ui
├── css
└── bootstrap.min.css
├── img
├── favicon.ico
├── logo.png
└── logo.svg
├── index.html
└── js
├── bootstrap.min.js
├── index.js
└── jquery.min.js
/.gitignore:
--------------------------------------------------------------------------------
1 | venv/
2 | __pycache__/
3 | *.pyc
4 | .DS_Store
5 | *.log
6 | *.log.*
7 | *.mypy_cache*
8 | *.cache*
9 | .pytest_cache/
10 | .idea
11 | htmlcov
12 | .pytest_cache/
13 | .coverage
14 | hostapd.conf
15 | rc.local
16 |
--------------------------------------------------------------------------------
/INSTALL.md:
--------------------------------------------------------------------------------
1 | # Installing python-wifi-connect
2 |
3 | ## NOTE: This application only installs and runs on Linux.
4 |
5 | ### Clone this repo
6 | 1. `git clone https://github.com/OpenAgricultureFoundation/python-wifi-connect.git`
7 | 1. `cd python-wifi-connect`
8 |
9 | ### You must have python3.6 and pip3.6 already installed.
10 |
11 | ### If you are not already running NetworkManager on your system
12 | `./scripts/optional_install_NetworkManager_on_Linux.sh`
13 |
14 | ### Install python-wifi-connect
15 | `./scripts/install.sh`
16 |
17 | ## Running
18 | Please read the [RUN.md](RUN.md) file.
19 |
20 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
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 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant 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 install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | 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 updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
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 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper 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 | Copyright (C)
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 appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # python-wifi-connect
2 | An application that displays a wifi configuration UI for embedded Linux devices.
3 |
4 | Inspired by the [wifi-connect](https://github.com/balena-io/wifi-connect) project written by [balena.io](https://www.balena.io/).
5 |
6 | # Install and Run
7 |
8 | Please read the [INSTALL.md](INSTALL.md) then the [RUN.md](RUN.md) files.
9 |
10 |
11 | # How it works
12 | 
13 |
14 | WiFi Connect interacts with NetworkManager, which should be the active network manager on the device's host OS.
15 |
16 | ### 1. Advertise: Device Creates Access Point
17 |
18 | WiFi Connect detects available WiFi networks and opens an access point with a captive portal. Connecting to this access point with a mobile phone or laptop allows new WiFi credentials to be configured.
19 |
20 | ### 2. Connect: User Connects Phone to Device Access Point
21 |
22 | Connect to the opened access point on the device from your mobile phone or laptop. The access point SSID is, by default, `PFC_EDU-` where "name" is something random like "shy-lake" or "green-frog".
23 |
24 | ### 3. Portal: Phone Shows Captive Portal to User
25 |
26 | After connecting to the access point from a mobile phone, it will detect the captive portal and open its web page. Opening any web page will redirect to the captive portal as well.
27 |
28 | ### 4. Credentials: User Enters Local WiFi Network Credentials on Phone
29 |
30 | The captive portal provides the option to select a WiFi SSID from a list with detected WiFi networks and enter a passphrase for the desired network.
31 |
32 | ### 5. Connected!: Device Connects to Local WiFi Network
33 |
34 | When the network credentials have been entered, WiFi Connect will disable the access point and try to connect to the network. If the connection fails, it will enable the access point for another attempt. If it succeeds, the configuration will be saved by NetworkManager.
35 |
36 | # Details
37 | * [Video demo of the application.](https://www.youtube.com/watch?v=TN7jXMmKV50)
38 | * [These are the geeky development details and background on this application.](docs/details.md)
39 |
40 |
41 |
--------------------------------------------------------------------------------
/RUN.md:
--------------------------------------------------------------------------------
1 | # Running python-wifi-connect
2 |
3 | If you missed it, this is how you [install the application](INSTALL.md).
4 |
5 | ## Running
6 | 1. To see help: `./scripts/run.sh -h`
7 | 1. To run and exit if there is an active connection: `sudo ./scripts/run.sh`
8 | 1. To run and delete any active connections first: `sudo ./scripts/run.sh -d`
9 | 1. Go look for the `PFC_EDU-` hotspot on your phone or laptop, you may have to turn OFF your wifi and turn it back on to see it. If you pick it, the portal will pop up.
10 | 1. Select one of the available wifis, and fill in the required security fields and click 'Connect'.
11 | 1. The application will exit when it is successfully connected.
12 | 1. If the user types an incorrect password, the hotspot is recreated and they can connect to it again to retry.
13 |
--------------------------------------------------------------------------------
/config/requirements.txt:
--------------------------------------------------------------------------------
1 | python-networkmanager==2.1
2 |
--------------------------------------------------------------------------------
/docs/console_cable.md:
--------------------------------------------------------------------------------
1 | # How to connect a console cable to a Raspberry Pi Zero
2 |
3 | You would want to use a setup like this if you are continually switching your Raspberry Pi (RPi) on and off wifi networks. Perhaps you are writing an app like python-wifi-connect or you are doing driver / console work and want to see the boot up messages.
4 |
5 | 1. Buy a serial console cable such as: [https://www.adafruit.com/product/954](https://www.adafruit.com/product/954)
6 | 1. Install the drivers for your OS to communicate with the cable (see the links on the above product page).
7 | 1. Use a seperate power cable for the RPi. If you try to power it off your USB port, it most likely won't work since newer RPi draw too much current.
8 | 1. Attach the cable to the correct RX, TX, GND pins on the RPi you have.
9 | * This image shows the cable connected to a RPi zero with the header soldered on.
10 | * Pi zero pin 6 to cable GND black wire.
11 | * Pi zero pin 8 to TX cable white wire.
12 | * Pi zero pin 10 to RX cable green wire.
13 | * [Pi zero pin out](https://pinout.xyz/pinout/serial_pi_zero).
14 | * 
15 | 1. Run a terminal program to connect to the cable's serial port on your machine. I develop on OSX, so I use:
16 | * `screen -S balena -t balena /dev/cu.SLAB_USBtoUART 115200`
17 |
18 |
19 | ## Balena cloud specific steps
20 |
21 | We use the balena cloud to manage our embedded application as a docker container. So that means to be able to log into the base OS they use, these steps have to be followed:
22 |
23 | 1. Configure a Balena DEVELOPMENT device in their cloud console (not Production, dev lets you login over ssh).
24 | 1. From the cloud console, download the .zip file and flash the image to an SD card using [Balena Etcher](https://www.balena.io/etcher/).
25 | 1. Follow the top steps for cable wiring and using `screen`.
26 | 1. You may have to press the 'enter/return' key on your keyboard after `screen` connects to see the prompt.
27 | 1. On a balena development OS, you can log in as 'root' with no password.
28 | 1. Then list what balena (docker) containers are running:
29 | ```
30 | balena ps
31 | ```
32 | 1. Then I can connect to a container to do my app development:
33 | ```
34 | balena container exec -it /bin/bash
35 | ```
36 |
37 |
38 |
39 |
--------------------------------------------------------------------------------
/docs/details.md:
--------------------------------------------------------------------------------
1 | # Implementation details intended for developers.
2 |
3 | When I refer to 'NetworkManager' as 'NM', I'm referring to the python module that communicates over the DBUS API to the NetworkManager Linux service.
4 |
5 |
6 | ## How the application works
7 | 1. Check if there is an active internet connection, if so we exit with nothing to do.
8 | 1. Start the [dnsmasq](https://en.wikipedia.org/wiki/Dnsmasq) utility to forward DNS, run a DHCP server and advertise us as a new wifi router.
9 | 1. Get and save a list of available Access Points (AP) and add a special place holder so the user can provide a hidden AP.
10 | 1. Use NM to create a local 'hotspot' AP.
11 | 1. Start our HTTP server.
12 | 1. When the user connects their machine to the AP we advertise, we act as a captured portal and display our user interface (UI) (in the `ui/` dir) which is an HTML form that allows the user to pick a local wifi and supply a password.
13 | 1. When a browser loads the UI, a bit of [javascript](../ui/js/index.js) is run which requests `/networks` from the HTTP server, a REST request. The server returns the list of AP we collected in step 3.
14 | 1. The HTTP server processes the form POST and uses NM to stop our hotspot and connect to the AP the user has selected. If this fails we go back to step 3.
15 | 1. If the device is successfully connected to an AP, we stop dnsmasq and exit.
16 |
17 | [See this flow diagram (lifted from balena)](images/flow.png) to visually show what is going on.
18 |
19 |
20 | ## References
21 | - This application uses the [python-networkmanager module](https://pypi.org/project/python-networkmanager/).
22 | - Source for the [python-networkmanager module](https://github.com/seveas/python-networkmanager) on GitHub.
23 | - Documentation for the [python-networkmanager module](https://pythonhosted.org/python-networkmanager/).
24 | - The above python module is just an API that communicates over DBUS to the [debian NetworkManager package](https://wiki.debian.org/NetworkManager) which must be installed.
25 | - [DBUS NetworkManager API](https://developer.gnome.org/NetworkManager/1.2/spec.html)
26 | - [The Rust language version of this application written by balena.io](https://github.com/balena-io/wifi-connect) is a great reference!
27 |
28 |
29 | ## Py NetworkManager
30 | See the `nm_scripts/` directory for the scripts I copied/modified to figure out how to use NM. Once tested / grokked, this code was integrated into the python HTTP server which handles user input.
31 |
32 | ## Development setup
33 | I [use this serial console cable](console_cable.md) setup to do development on the Raspberry Pi.
34 |
35 |
36 | ## Why?
37 | I ([Rob Baynes](https://github.com/rbaynes)) had to have a way to get a headless embedded Linux device connected to a local WiFi in as smooth and easy a manner as possible. So anyone could make the connection, middle school students, teachers, my Mom...
38 |
39 | Since we are using the [Balena cloud](https://www.balena.io/cloud) to deploy our food computer embedded application to our devices, it was logical to use the [wifi-connect](https://github.com/balena-io/wifi-connect) project they wrote.
40 |
41 | The problem is that I needed to make some changes (to support hidden SSIDs) and progress on the open source project is slow. I forked the project into our organizaion and started modifying it. Also learning the Rust language at the same time. I got stuck and gave up when the rustc compiler kept repeatedly crashing my Raspberry Pi Zero while building wifi-connect. Attempt two was to cross compile wifi-connect for ARMv6 and ARMv7 on a Linux x86-64 machine. Neither worked and both binaries core dumped when run on the RPi. So at this point, after wasting 3 days, I decided to rewite the application using Python3.6 (which is the same language we use for all our OpenAg projects).
42 |
43 | I hope you enjoy and add to this project!
44 | [-rob](https://github.com/rbaynes)
45 |
46 |
--------------------------------------------------------------------------------
/docs/images/flow.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OpenAgricultureFoundation/python-wifi-connect/2563fe088765f42f1137c4e1c8bbb54ba56916d3/docs/images/flow.png
--------------------------------------------------------------------------------
/docs/images/how-it-works.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OpenAgricultureFoundation/python-wifi-connect/2563fe088765f42f1137c4e1c8bbb54ba56916d3/docs/images/how-it-works.png
--------------------------------------------------------------------------------
/docs/images/pi_zero_console_cable.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OpenAgricultureFoundation/python-wifi-connect/2563fe088765f42f1137c4e1c8bbb54ba56916d3/docs/images/pi_zero_console_cable.png
--------------------------------------------------------------------------------
/nm_scripts/delete_all_wifi_connections.py:
--------------------------------------------------------------------------------
1 | import NetworkManager
2 |
3 | ### Run this before we run 'wifi-connect' to clear out pre-configured networks
4 | def clear_connections():
5 | # Get all known connections
6 | connections = NetworkManager.Settings.ListConnections()
7 |
8 | # Delete the '802-11-wireless' connections
9 | for connection in connections:
10 | if connection.GetSettings()["connection"]["type"] == "802-11-wireless":
11 | print("Deleting connection "
12 | + connection.GetSettings()["connection"]["id"]
13 | )
14 | connection.Delete()
15 |
16 | if __name__=="__main__":
17 | clear_connections()
18 |
19 | """
20 | We DO want to kill the resin wifi connection.
21 |
22 | Deleting connection resin-wifi-01
23 | Deleting connection spanky
24 | """
25 |
--------------------------------------------------------------------------------
/nm_scripts/net-man-util.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3.6
2 | #
3 | # Command-line tool to interact with NetworkManager. With this tool, you can
4 | # inspect various configuration items and (de-)activate connections.
5 | #
6 | # (C) 2011-2016 Dennis Kaarsemaker
7 | # License: zlib
8 |
9 | from __future__ import print_function
10 |
11 | usage = """%prog [options] action [arguments]
12 |
13 | Actions:
14 | list - List all defined and active connections
15 | activate - Activate a connection
16 | deactivate - Deactivate a connection
17 | offline - Deactivate all connections
18 | enable - Enable specific connection types
19 | disable - Disable specific connection types
20 | dump - Dump connection info
21 | info - Information about a connection"""
22 |
23 | import datetime
24 | from dbus.exceptions import DBusException
25 | import NetworkManager
26 | import optparse
27 | import socket
28 | import struct
29 | import sys
30 |
31 | PY3 = sys.version_info[0] >= 3
32 |
33 | def main():
34 | p = optparse.OptionParser(usage=usage)
35 | opts, args = p.parse_args()
36 |
37 | if not args:
38 | p.print_help()
39 | sys.exit(1)
40 |
41 | if args[0] == 'list':
42 | list_()
43 |
44 | elif args[0] == 'offline':
45 | offline()
46 |
47 | elif args[0] == 'visible':
48 | visible()
49 |
50 | elif len(args) < 2:
51 | p.print_help()
52 | sys.exit(1)
53 |
54 | elif args[0] == 'activate':
55 | activate(args[1:])
56 |
57 | elif args[0] == 'deactivate':
58 | deactivate(args[1:])
59 |
60 | elif args[0] == 'enable':
61 | enable(args[1:])
62 |
63 | elif args[0] == 'disable':
64 | disable(args[1:])
65 |
66 | elif args[0] == 'info':
67 | info(args[1:])
68 |
69 | elif args[0] == 'dump':
70 | dump(args[1:])
71 |
72 | else:
73 | p.print_help()
74 | sys.exit(1)
75 |
76 | def list_():
77 | active = [x.Connection.GetSettings()['connection']['id']
78 | for x in NetworkManager.NetworkManager.ActiveConnections]
79 | connections = [(x.GetSettings()['connection']['id'], x.GetSettings()['connection']['type'])
80 | for x in NetworkManager.Settings.ListConnections()]
81 | fmt = "%%s %%-%ds %%s" % max([len(x[0]) for x in connections])
82 | for conn in sorted(connections):
83 | prefix = '* ' if conn[0] in active else ' '
84 | print(fmt % (prefix, conn[0], conn[1]))
85 |
86 | def activate(names):
87 | connections = NetworkManager.Settings.ListConnections()
88 | connections = dict([(x.GetSettings()['connection']['id'], x) for x in connections])
89 |
90 | if not NetworkManager.NetworkManager.NetworkingEnabled:
91 | NetworkManager.NetworkManager.Enable(True)
92 | for n in names:
93 | if n not in connections:
94 | print("No such connection: %s" % n, file=sys.stderr)
95 | sys.exit(1)
96 |
97 | print("Activating connection '%s'" % n)
98 | conn = connections[n]
99 | ctype = conn.GetSettings()['connection']['type']
100 | if ctype == 'vpn':
101 | for dev in NetworkManager.NetworkManager.GetDevices():
102 | if dev.State == NetworkManager.NM_DEVICE_STATE_ACTIVATED and dev.Managed:
103 | break
104 | else:
105 | print("No active, managed device found", file=sys.stderr)
106 | sys.exit(1)
107 | else:
108 | dtype = {
109 | '802-11-wireless': 'wlan',
110 | 'gsm': 'wwan',
111 | }
112 | if dtype in connection_types:
113 | enable(dtype)
114 | dtype = {
115 | '802-11-wireless': NetworkManager.NM_DEVICE_TYPE_WIFI,
116 | '802-3-ethernet': NetworkManager.NM_DEVICE_TYPE_ETHERNET,
117 | 'gsm': NetworkManager.NM_DEVICE_TYPE_MODEM,
118 | }.get(ctype,ctype)
119 | devices = NetworkManager.NetworkManager.GetDevices()
120 |
121 | for dev in devices:
122 | if dev.DeviceType == dtype and dev.State == NetworkManager.NM_DEVICE_STATE_DISCONNECTED:
123 | break
124 | else:
125 | print("No suitable and available %s device found" % ctype, file=sys.stderr)
126 | sys.exit(1)
127 |
128 | NetworkManager.NetworkManager.ActivateConnection(conn, dev, "/")
129 |
130 | def deactivate(names):
131 | active = NetworkManager.NetworkManager.ActiveConnections
132 | active = dict([(x.Connection.GetSettings()['connection']['id'], x) for x in active])
133 |
134 | for n in names:
135 | if n not in active:
136 | print("No such connection: %s" % n, file=sys.stderr)
137 | sys.exit(1)
138 |
139 | print("Deactivating connection '%s'" % n)
140 | NetworkManager.NetworkManager.DeactivateConnection(active[n])
141 |
142 | def offline():
143 | try:
144 | NetworkManager.NetworkManager.Enable(False)
145 | except DBusException as e:
146 | if e.get_dbus_name() != 'org.freedesktop.NetworkManager.AlreadyEnabledOrDisabled':
147 | raise
148 |
149 | connection_types = ['wireless','wwan','wimax']
150 | def enable(names):
151 | for n in names:
152 | if n not in connection_types:
153 | print("No such connection type: %s" % n, file=sys.stderr)
154 | sys.exit(1)
155 | setattr(NetworkManager.NetworkManager, n.title() + 'Enabled', True)
156 |
157 | def disable(names):
158 | for n in names:
159 | if n not in connection_types:
160 | print("No such connection type: %s" % n, file=sys.stderr)
161 | sys.exit(1)
162 | setattr(NetworkManager.NetworkManager, n.title() + 'Enabled', False)
163 |
164 | def info(names):
165 | connections = [x.GetSettings() for x in NetworkManager.Settings.ListConnections()]
166 | connections = dict([(x['connection']['id'], x) for x in connections])
167 |
168 | for n in names:
169 | if not PY3:
170 | n = n.decode('utf-8')
171 | if n not in connections:
172 | print("No such connection: %s" % n, file=sys.stderr)
173 | return
174 |
175 | line = "Info about '%s'" % n
176 | print(line + "\n" + '=' * len(line))
177 | conn = connections[n]
178 | print("Type:", conn['connection']['type'])
179 | print("Connect automatically:", ["No","Yes"][conn['connection'].get('autoconnect', True)])
180 | if 'timestamp' in conn['connection']:
181 | print("Last connected on:", str(datetime.datetime.fromtimestamp(conn['connection']['timestamp'])))
182 | else:
183 | print("Never connected")
184 | print("IPv4 settings (%s)" % conn['ipv4']['method'])
185 | print(" Address(es):", ', '.join([x[0] for x in conn['ipv4']['addresses']]) or '(Automatic)')
186 | print(" DNS servers:", ', '.join(conn['ipv4']['dns']) or '(Automatic)')
187 | print(" Routes:", ", ".join(["%s/%d -> %s" % x[:3] for x in conn['ipv4']['routes']]))
188 | print(" Can be default route:", ["Yes","No"][conn['ipv4'].get('never-default', False)])
189 |
190 | if conn['connection']['type'] == '802-3-ethernet':
191 | print("Physical link")
192 | print(" MAC address:", conn['802-3-ethernet'].get('mac-address', '(Automatic)'))
193 | elif conn['connection']['type'] == '802-11-wireless':
194 | print("Wireless link")
195 | print(" MAC address:", conn['802-11-wireless'].get('mac-address', '(Automatic)'))
196 | print(" SSID:", conn['802-11-wireless']['ssid'])
197 | if 'security' in conn['802-11-wireless']:
198 | print(" Wireless security:", conn[conn['802-11-wireless']['security']]['key-mgmt'])
199 | elif conn['connection']['type'] == 'vpn':
200 | print("VPN")
201 | print(" Type:", conn['vpn']['service-type'].rsplit('.',1)[-1])
202 | print(" Remote:", conn['vpn']['data']['remote'])
203 |
204 | def dump(names):
205 | from pprint import pprint
206 | connections = {}
207 | for conn in NetworkManager.Settings.ListConnections():
208 | settings = conn.GetSettings()
209 | secrets = conn.GetSecrets()
210 | for key in secrets:
211 | settings[key].update(secrets[key])
212 | connections[settings['connection']['id']] = settings
213 |
214 | for n in names:
215 | if n not in connections:
216 | print("No such connection: %s" % n, file=sys.stderr)
217 |
218 | pprint(connections[n])
219 |
220 | def visible():
221 | for device in NetworkManager.NetworkManager.GetDevices():
222 | if device.DeviceType != NetworkManager.NM_DEVICE_TYPE_WIFI:
223 | continue
224 | print("Visible on %s" % device.Udi[device.Udi.rfind('/')+1:])
225 | device = device.SpecificDevice()
226 | active = device.ActiveAccessPoint
227 | aps = device.GetAccessPoints()
228 | for ap in aps:
229 | prefix = '* ' if ap.object_path == active.object_path else ' '
230 | print("%s %s" % (prefix, ap.Ssid))
231 |
232 | if __name__ == '__main__':
233 | main()
234 |
--------------------------------------------------------------------------------
/nm_scripts/show_current_AP.py:
--------------------------------------------------------------------------------
1 | # Display all visible SSIDs
2 | # When connected to an AP, that is all that will be in the list.
3 | # When there is no active connection, this will show all visible APs.
4 |
5 | import NetworkManager
6 |
7 | NM_SECURITY_NONE = 0x0
8 | NM_SECURITY_WEP = 0x1
9 | NM_SECURITY_WPA = 0x2
10 | NM_SECURITY_WPA2 = 0x4
11 | NM_SECURITY_ENTERPRISE = 0x8
12 |
13 | USER_INPUT_NONE = 0x0
14 | USER_INPUT_PASSWORD = 0x1
15 | USER_INPUT_USERNAME = 0x2
16 |
17 | for dev in NetworkManager.NetworkManager.GetDevices():
18 | if dev.DeviceType != NetworkManager.NM_DEVICE_TYPE_WIFI:
19 | continue
20 | for ap in dev.GetAccessPoints():
21 | #print('%-30s %dMHz %d%%' % (ap.Ssid, ap.Frequency, ap.Strength))
22 |
23 | # Get Flags, WpaFlags and RsnFlags, all are bit OR'd combinations
24 | # of the NM_802_11_AP_SEC_* bit flags.
25 | # https://developer.gnome.org/NetworkManager/1.2/nm-dbus-types.html#NM80211ApSecurityFlags
26 |
27 | security = NM_SECURITY_NONE
28 | user_input = USER_INPUT_NONE
29 |
30 | # Based on a subset of the flag settings we can determine which
31 | # type of security this AP uses.
32 | # We can also determine what input we need from the user to connect to
33 | # any given AP (required for our dynamic UI form).
34 | if ap.Flags & NetworkManager.NM_802_11_AP_FLAGS_PRIVACY and \
35 | ap.WpaFlags == NetworkManager.NM_802_11_AP_SEC_NONE and \
36 | ap.RsnFlags == NetworkManager.NM_802_11_AP_SEC_NONE:
37 | security = NM_SECURITY_WEP
38 | user_input = USER_INPUT_PASSWORD
39 |
40 | if ap.WpaFlags != NetworkManager.NM_802_11_AP_SEC_NONE:
41 | security = NM_SECURITY_WPA
42 | user_input = USER_INPUT_PASSWORD
43 |
44 | if ap.RsnFlags != NetworkManager.NM_802_11_AP_SEC_NONE:
45 | security = NM_SECURITY_WPA2
46 | user_input = USER_INPUT_PASSWORD
47 |
48 | if ap.WpaFlags & NetworkManager.NM_802_11_AP_SEC_KEY_MGMT_802_1X or \
49 | ap.RsnFlags & NetworkManager.NM_802_11_AP_SEC_KEY_MGMT_802_1X:
50 | security = NM_SECURITY_ENTERPRISE
51 | user_input = USER_INPUT_PASSWORD
52 | user_input |= USER_INPUT_USERNAME
53 |
54 | # Decode our flag into a display string
55 | security_str = ''
56 | if security == NM_SECURITY_NONE:
57 | security_str = 'NONE'
58 |
59 | if security & NM_SECURITY_WEP:
60 | security_str += 'WEP '
61 |
62 | if security & NM_SECURITY_WPA:
63 | security_str += 'WPA '
64 |
65 | if security & NM_SECURITY_WPA2:
66 | security_str += 'WPA2 '
67 |
68 | if security & NM_SECURITY_ENTERPRISE:
69 | security_str += 'ENTERPRISE'
70 |
71 | # Decode our flag into a display string
72 | input_str = ''
73 | if user_input == USER_INPUT_NONE:
74 | input_str = 'NONE'
75 |
76 | if user_input & USER_INPUT_USERNAME:
77 | input_str += 'USERNAME '
78 |
79 | if user_input & USER_INPUT_PASSWORD:
80 | input_str += 'PASSWORD '
81 |
82 | print(f'{ap.Ssid:15} Flags=0x{ap.Flags:X} WpaFlags=0x{ap.WpaFlags:X} RsnFlags=0x{ap.RsnFlags:X} Security={security_str:10} Input={input_str}')
83 |
84 |
85 |
86 |
87 |
--------------------------------------------------------------------------------
/nm_scripts/start_dnsmasq.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | INSTALL_PATH=`which dnsmasq`
4 | if [[ ! -f "$INSTALL_PATH" ]]; then
5 | echo "ERROR: dnsmasq is not installed."
6 | exit 1
7 | fi
8 |
9 | DEFAULT_GATEWAY="192.168.42.1"
10 | DEFAULT_DHCP_RANGE="192.168.42.2,192.168.42.254"
11 | DEFAULT_INTERFACE="wlan0" # use 'ip link show' to see list of interfaces
12 |
13 | # run dnsmasq in the background
14 | CMD="dnsmasq"\
15 | ' --address=/#/'$DEFAULT_GATEWAY\
16 | " --dhcp-range=$DEFAULT_DHCP_RANGE"\
17 | " --dhcp-option=option:router,$DEFAULT_GATEWAY"\
18 | " --interface=$DEFAULT_INTERFACE"\
19 | " --keep-in-foreground"\
20 | " --bind-interfaces"\
21 | " --except-interface=lo"\
22 | " --conf-file"\
23 | " --no-hosts"
24 |
25 | echo "Running in background: $CMD"
26 | `$CMD` &
27 |
28 |
29 |
--------------------------------------------------------------------------------
/nm_scripts/start_hotspot.py:
--------------------------------------------------------------------------------
1 | """
2 | Start a local hotspot using NetworkManager.
3 | You do this by sending a dict to AddConnection.
4 | The dict below was generated with n-m dump on an existing connection and then anonymised.
5 |
6 | # manually (in base balena OS) add a local hotspot with NO password (open)
7 | nmcli connection add type wifi ifname wlan0 con-name hotspot autoconnect yes ssid PFC_EDU mode ap
8 | nmcli connection modify hotspot 802-11-wireless.mode ap ipv4.method shared
9 | nmcli connection up hotspot
10 |
11 | # if you want a password on the hotspot, add this to the modify command:
12 | # 802-11-wireless-security.key-mgmt wpa-psk 802-11-wireless-security.psk 'PASSWORD'
13 |
14 | # In our container, use NM to dump the connection (and clean it up):
15 | # ./net-man-util.py dump hotspot
16 | #
17 | # Also check what the rust wifi-connect does
18 | # cd /usr/src/app && ./wifi-connect -s hotspot
19 |
20 | """
21 |
22 | import NetworkManager
23 | import uuid
24 | import os, sys
25 |
26 |
27 | connection_ID = 'PFC_EDU'
28 | hotspot = {
29 | '802-11-wireless': {'band': 'bg',
30 | 'mode': 'ap',
31 | 'ssid': 'PFC_EDU-'+os.getenv('RESIN_DEVICE_NAME_AT_INIT')},
32 | 'connection': {'autoconnect': False,
33 | 'id': connection_ID,
34 | 'interface-name': 'wlan0',
35 | 'type': '802-11-wireless',
36 | 'uuid': str(uuid.uuid4())},
37 | 'ipv4': {'address-data': [{'address': '192.168.42.1', 'prefix': 24}],
38 | 'addresses': [['192.168.42.1', 24, '0.0.0.0']],
39 | 'method': 'manual'},
40 | 'ipv6': {'method': 'auto'}
41 | }
42 |
43 | NetworkManager.Settings.AddConnection(hotspot)
44 | print(f"Added connection: {hotspot}")
45 |
46 | # Now find this connection and its device
47 | connections = NetworkManager.Settings.ListConnections()
48 | connections = dict([(x.GetSettings()['connection']['id'], x) for x in connections])
49 | conn = connections[connection_ID]
50 |
51 | # Find a suitable device
52 | ctype = conn.GetSettings()['connection']['type']
53 | dtype = {'802-11-wireless': NetworkManager.NM_DEVICE_TYPE_WIFI}.get(ctype,ctype)
54 | devices = NetworkManager.NetworkManager.GetDevices()
55 |
56 | for dev in devices:
57 | #if dev.DeviceType == dtype and dev.State == NetworkManager.NM_DEVICE_STATE_DISCONNECTED:
58 | if dev.DeviceType == dtype:
59 | break
60 | else:
61 | print("No suitable and available %s device found" % ctype)
62 | sys.exit(1)
63 |
64 | # And connect
65 | NetworkManager.NetworkManager.ActivateConnection(conn, dev, "/")
66 | print(f"Activated connection={conn}, dev={dev}.")
67 |
68 |
69 |
--------------------------------------------------------------------------------
/scripts/install.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | # Check OS we are running on. NetworkManager only works on Linux.
4 | if [[ "$OSTYPE" != "linux"* ]]; then
5 | echo "ERROR: This application only runs on Linux."
6 | if [[ "$OSTYPE" == "darwin"* ]]; then
7 | echo "WARNING: OSX is only supported for development/simulation."
8 | echo "NetworkManager and DBUS won't install or work on OSX."
9 | else
10 | exit 1
11 | fi
12 | fi
13 |
14 | # Save the path to THIS script (before we go changing dirs)
15 | TOPDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
16 | # The top of our source tree is the parent of this scripts dir
17 | TOPDIR+=/..
18 | cd $TOPDIR
19 |
20 | # Check if python3 and pip are installed
21 | echo "Checking that python3 and pip are installed..."
22 | INSTALL_PATH=`which python3`
23 | if [[ ! -f "$INSTALL_PATH" ]]; then
24 | echo "ERROR: python3 is not installed."
25 | exit 1
26 | fi
27 | INSTALL_PATH=`which pip3`
28 | if [[ ! -f "$INSTALL_PATH" ]]; then
29 | echo "ERROR: pip3 is not installed."
30 | exit 1
31 | fi
32 |
33 | # Remove any existing virtual environment
34 | rm -fr $TOPDIR/venv
35 |
36 | # Create a virtual environment (venv)
37 | echo "Creating a python virtual environment..."
38 | python3 -m venv $TOPDIR/venv
39 |
40 | # Only install python modules on Linux (they are OS specific).
41 | if [[ "$OSTYPE" == "linux"* ]]; then
42 | # Use the venv
43 | source $TOPDIR/venv/bin/activate
44 |
45 | # Install the python modules our app uses into our venv
46 | echo "Installing python modules..."
47 | pip3 install -r $TOPDIR/config/requirements.txt
48 |
49 | # Deactivate the venv
50 | deactivate
51 | fi
52 |
53 | echo "Done."
54 |
55 |
--------------------------------------------------------------------------------
/scripts/optional_install_NetworkManager_on_Linux.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | echo "This script is optional."
4 | echo "It verifies NetworkManager is installed."
5 | echo "If not, installs it (and in the process disables the dhcpcd service)"
6 | echo "Our OpenAg balena base OS already has NetworkManager and DBUS installed."
7 | echo ""
8 |
9 | check_os_version () {
10 | if [[ "$OSTYPE" != "linux"* ]]; then
11 | echo "ERROR: This application only runs on Linux."
12 | exit 1
13 | fi
14 |
15 | local _version=""
16 | if [ -f /etc/os-release ]; then
17 | _version=$(grep -oP 'VERSION="\K[^"]+' /etc/os-release)
18 | fi
19 | if [ "$_version" != "9 (stretch)" ]; then
20 | echo "ERROR: Distribution not based on Debian 9 (stretch)."
21 | exit 1
22 | fi
23 | }
24 |
25 | install_network_manager () {
26 | echo "Updating Debian package list..."
27 | apt-get update
28 |
29 | echo "Downloading NetworkManager..."
30 | apt-get install -y -d network-manager
31 |
32 | echo "Stopping dhcpcd..."
33 | systemctl stop dhcpcd
34 | systemctl disable dhcpcd
35 |
36 | echo "Installing NetworkManager..."
37 | apt-get install -y network-manager
38 | apt-get clean
39 | }
40 |
41 | # This only works on Linux
42 | check_os_version
43 |
44 | # Confirm the user wants to install...
45 | read -r -p "Do you want to install? [y/N]: " response
46 | response=${response,,} # convert to lowercase
47 | if [[ ! $response =~ ^(yes|y)$ ]]; then
48 | exit 0
49 | fi
50 |
51 | # Update packages and install
52 | install_network_manager
53 |
54 |
55 |
56 |
57 |
58 |
--------------------------------------------------------------------------------
/scripts/run.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | # Command line args:
4 | # -a Default: 192.168.42.1
5 | # -p Default: 80
6 | # -u Default: "../ui"
7 | # -d Delete Connections First Default: False
8 | # -r Device Registration Code Default: ""
9 | # -h Show help.
10 |
11 | # Check OS we are running on. NetworkManager only works on Linux.
12 | if [[ "$OSTYPE" != "linux"* ]]; then
13 | echo "ERROR: This application only runs on Linux."
14 | exit 1
15 | fi
16 |
17 | # Save the path to THIS script (before we go changing dirs)
18 | TOPDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd )"
19 | # The top of our source tree is the parent of this scripts dir
20 | cd $TOPDIR
21 |
22 | # Use the venv
23 | source $TOPDIR/venv/bin/activate
24 |
25 | # Start our application
26 | python3 $TOPDIR/src/http_server.py -u $TOPDIR/ui/ $*
27 |
--------------------------------------------------------------------------------
/src/dnsmasq.py:
--------------------------------------------------------------------------------
1 | # start / stop the dnsmasq process
2 |
3 | import subprocess, time
4 |
5 | DEFAULT_GATEWAY="192.168.42.1"
6 | DEFAULT_DHCP_RANGE="192.168.42.2,192.168.42.254"
7 | DEFAULT_INTERFACE="wlan0" # use 'ip link show' to see list of interfaces
8 |
9 |
10 | def stop():
11 | ps = subprocess.Popen("ps -e | grep ' dnsmasq' | cut -c 1-6", shell=True, stdout=subprocess.PIPE)
12 | pid = ps.stdout.read()
13 | ps.stdout.close()
14 | ps.wait()
15 | pid = pid.decode('utf-8')
16 | pid = pid.strip()
17 | if 0 < len(pid):
18 | print(f"Killing dnsmasq, PID='{pid}'")
19 | ps = subprocess.Popen(f"kill -9 {pid}", shell=True)
20 | ps.wait()
21 |
22 |
23 | def start():
24 | # first kill any existing dnsmasq
25 | stop()
26 |
27 | # build the list of args
28 | path = "/usr/sbin/dnsmasq"
29 | args = [path]
30 | args.append(f"--address=/#/{DEFAULT_GATEWAY}")
31 | args.append(f"--dhcp-range={DEFAULT_DHCP_RANGE}")
32 | args.append(f"--dhcp-option=option:router,{DEFAULT_GATEWAY}")
33 | args.append(f"--interface={DEFAULT_INTERFACE}")
34 | args.append(f"--keep-in-foreground")
35 | args.append(f"--bind-interfaces")
36 | args.append(f"--except-interface=lo")
37 | args.append(f"--conf-file")
38 | args.append(f"--no-hosts" )
39 |
40 | # run dnsmasq in the background and save a reference to the object
41 | ps = subprocess.Popen(args)
42 | # don't wait here, proc runs in background until we kill it.
43 |
44 | # give a few seconds for the proc to start
45 | time.sleep(2)
46 | print(f'Started dnsmasq, PID={ps.pid}')
47 |
48 |
49 |
--------------------------------------------------------------------------------
/src/http_server.py:
--------------------------------------------------------------------------------
1 | # Our main wifi-connect application, which is based around an HTTP server.
2 |
3 | import os, getopt, sys, json, atexit
4 | from http.server import HTTPServer, SimpleHTTPRequestHandler
5 | from urllib.parse import parse_qs
6 | from io import BytesIO
7 |
8 | # Local modules
9 | import netman
10 | import dnsmasq
11 |
12 | # Defaults
13 | ADDRESS = '192.168.42.1'
14 | PORT = 80
15 | UI_PATH = '../ui'
16 |
17 |
18 | #------------------------------------------------------------------------------
19 | # called at exit
20 | def cleanup():
21 | print("Cleaning up prior to exit.")
22 | dnsmasq.stop()
23 | netman.stop_hotspot()
24 |
25 |
26 | #------------------------------------------------------------------------------
27 | # A custom http server class in which we can set the default path it serves
28 | # when it gets a GET request.
29 | class MyHTTPServer(HTTPServer):
30 | def __init__(self, base_path, server_address, RequestHandlerClass):
31 | self.base_path = base_path
32 | HTTPServer.__init__(self, server_address, RequestHandlerClass)
33 |
34 |
35 | #------------------------------------------------------------------------------
36 | # A custom http request handler class factory.
37 | # Handle the GET and POST requests from the UI form and JS.
38 | # The class factory allows us to pass custom arguments to the handler.
39 | def RequestHandlerClassFactory(address, ssids, rcode):
40 |
41 | class MyHTTPReqHandler(SimpleHTTPRequestHandler):
42 |
43 | def __init__(self, *args, **kwargs):
44 | # We must set our custom class properties first, since __init__() of
45 | # our super class will call do_GET().
46 | self.address = address
47 | self.ssids = ssids
48 | self.rcode = rcode
49 | super(MyHTTPReqHandler, self).__init__(*args, **kwargs)
50 |
51 | # See if this is a specific request, otherwise let the server handle it.
52 | def do_GET(self):
53 |
54 | print(f'do_GET {self.path}')
55 |
56 | # Handle the hotspot starting and a computer connecting to it,
57 | # we have to return a redirect to the gateway to get the
58 | # captured portal to show up.
59 | if '/hotspot-detect.html' == self.path:
60 | self.send_response(301) # redirect
61 | new_path = f'http://{self.address}/'
62 | print(f'redirecting to {new_path}')
63 | self.send_header('Location', new_path)
64 | self.end_headers()
65 |
66 | if '/generate_204' == self.path:
67 | self.send_response(301) # redirect
68 | new_path = f'http://{self.address}/'
69 | print(f'redirecting to {new_path}')
70 | self.send_header('Location', new_path)
71 | self.end_headers()
72 |
73 | # Handle a REST API request to return the device registration code
74 | if '/regcode' == self.path:
75 | self.send_response(200)
76 | self.end_headers()
77 | response = BytesIO()
78 | response.write(self.rcode.encode('utf-8'))
79 | print(f'GET {self.path} returning: {response.getvalue()}')
80 | self.wfile.write(response.getvalue())
81 | return
82 |
83 | # Handle a REST API request to return the list of SSIDs
84 | if '/networks' == self.path:
85 | self.send_response(200)
86 | self.end_headers()
87 | response = BytesIO()
88 | ssids = self.ssids # passed in to the class factory
89 | """ map whatever we get from net man to our constants:
90 | Security:
91 | NONE
92 | HIDDEN
93 | WEP
94 | WPA
95 | WPA2
96 | ENTERPRISE
97 | Required user input (from UI form):
98 | NONE - No input requried.
99 | HIDDEN, WEP, WPA, WPA2 - Need password.
100 | ENTERPRISE - Need username and password.
101 | """
102 | response.write(json.dumps(ssids).encode('utf-8'))
103 | print(f'GET {self.path} returning: {response.getvalue()}')
104 | self.wfile.write(response.getvalue())
105 | return
106 |
107 | # Not sure if this is just OSX hitting the captured portal,
108 | # but we need to exit if we get it.
109 | if '/bag' == self.path:
110 | sys.exit()
111 |
112 | # All other requests are handled by the server which vends files
113 | # from the ui_path we were initialized with.
114 | super().do_GET()
115 |
116 |
117 | # test with: curl localhost:5000 -d "{'name':'value'}"
118 | def do_POST(self):
119 | content_length = int(self.headers['Content-Length'])
120 | body = self.rfile.read(content_length)
121 | self.send_response(200)
122 | self.end_headers()
123 | response = BytesIO()
124 | fields = parse_qs(body.decode('utf-8'))
125 | #print(f'POST received: {fields}')
126 |
127 | # Parse the form post
128 | FORM_SSID = 'ssid'
129 | FORM_HIDDEN_SSID = 'hidden-ssid'
130 | FORM_USERNAME = 'identity'
131 | FORM_PASSWORD = 'passphrase'
132 |
133 | if FORM_SSID not in fields:
134 | print(f'Error: POST is missing {FORM_SSID} field.')
135 | return
136 |
137 | ssid = fields[FORM_SSID][0]
138 | password = None
139 | username = None
140 | if FORM_HIDDEN_SSID in fields:
141 | ssid = fields[FORM_HIDDEN_SSID][0] # override with hidden name
142 | if FORM_USERNAME in fields:
143 | username = fields[FORM_USERNAME][0]
144 | if FORM_PASSWORD in fields:
145 | password = fields[FORM_PASSWORD][0]
146 |
147 | # Look up the ssid in the list we sent, to find out its security
148 | # type for the new connection we have to make
149 | conn_type = netman.CONN_TYPE_SEC_NONE # Open, no auth AP
150 |
151 | if FORM_HIDDEN_SSID in fields:
152 | conn_type = netman.CONN_TYPE_SEC_PASSWORD # Assumption...
153 |
154 | for s in self.ssids:
155 | if FORM_SSID in s and ssid == s[FORM_SSID]:
156 | if s['security'] == "ENTERPRISE":
157 | conn_type = netman.CONN_TYPE_SEC_ENTERPRISE
158 | elif s['security'] == "NONE":
159 | conn_type = netman.CONN_TYPE_SEC_NONE
160 | else:
161 | # all others need a password
162 | conn_type = netman.CONN_TYPE_SEC_PASSWORD
163 | break
164 |
165 | # Stop the hotspot
166 | netman.stop_hotspot()
167 |
168 | # Connect to the user's selected AP
169 | success = netman.connect_to_AP(conn_type=conn_type, ssid=ssid, \
170 | username=username, password=password)
171 |
172 | if success:
173 | response.write(b'OK\n')
174 | else:
175 | response.write(b'ERROR\n')
176 | self.wfile.write(response.getvalue())
177 |
178 | # Handle success or failure of the new connection
179 | if success:
180 | print(f'Connected! Exiting app.')
181 | sys.exit()
182 | else:
183 | print(f'Connection failed, restarting the hotspot.')
184 |
185 | # Update the list of SSIDs since we are not connected
186 | self.ssids = netman.get_list_of_access_points()
187 |
188 | # Start the hotspot again
189 | netman.start_hotspot()
190 |
191 | return MyHTTPReqHandler # the class our factory just created.
192 |
193 |
194 | #------------------------------------------------------------------------------
195 | # Create the hotspot, start dnsmasq, start the HTTP server.
196 | def main(address, port, ui_path, rcode, delete_connections):
197 |
198 | # See if caller wants to delete all existing connections first
199 | if delete_connections:
200 | netman.delete_all_wifi_connections()
201 |
202 | # Check if we are already connected, if so we are done.
203 | if netman.have_active_internet_connection():
204 | print('Already connected to the internet, nothing to do, exiting.')
205 | sys.exit()
206 |
207 | # Get list of available AP from net man.
208 | # Must do this AFTER deleting any existing connections (above),
209 | # and BEFORE starting our hotspot (or the hotspot will be the only thing
210 | # in the list).
211 | ssids = netman.get_list_of_access_points()
212 |
213 | # Start the hotspot
214 | if not netman.start_hotspot():
215 | print('Error starting hotspot, exiting.')
216 | sys.exit(1)
217 |
218 | # Start dnsmasq (to advertise us as a router so captured portal pops up
219 | # on the users machine to vend our UI in our http server)
220 | dnsmasq.start()
221 |
222 | # Find the ui directory which is up one from where this file is located.
223 | web_dir = os.path.join(os.path.dirname(__file__), ui_path)
224 | print(f'HTTP serving directory: {web_dir} on {address}:{port}')
225 |
226 | # Change to this directory so the HTTPServer returns the index.html in it
227 | # by default when it gets a GET.
228 | os.chdir(web_dir)
229 |
230 | # Host:Port our HTTP server listens on
231 | server_address = (address, port)
232 |
233 | # Custom request handler class (so we can pass in our own args)
234 | MyRequestHandlerClass = RequestHandlerClassFactory(address, ssids, rcode)
235 |
236 | # Start an HTTP server to serve the content in the ui dir and handle the
237 | # POST request in the handler class.
238 | print(f'Waiting for a connection to our hotspot {netman.get_hotspot_SSID()} ...')
239 | httpd = MyHTTPServer(web_dir, server_address, MyRequestHandlerClass)
240 | try:
241 | httpd.serve_forever()
242 | except KeyboardInterrupt:
243 | dnsmasq.stop()
244 | netman.stop_hotspot()
245 | httpd.server_close()
246 |
247 |
248 | #------------------------------------------------------------------------------
249 | # Util to convert a string to an int, or provide a default.
250 | def string_to_int(s, default):
251 | try:
252 | return int(s)
253 | except ValueError:
254 | return default
255 |
256 |
257 | #------------------------------------------------------------------------------
258 | # Entry point and command line argument processing.
259 | if __name__ == "__main__":
260 | atexit.register(cleanup)
261 |
262 | address = ADDRESS
263 | port = PORT
264 | ui_path = UI_PATH
265 | delete_connections = False
266 | rcode = ''
267 |
268 | usage = ''\
269 | f'Command line args: \n'\
270 | f' -a Default: {address} \n'\
271 | f' -p Default: {port} \n'\
272 | f' -u Default: "{ui_path}" \n'\
273 | f' -d Delete Connections First Default: {delete_connections} \n'\
274 | f' -r Device Registration Code Default: "" \n'\
275 | f' -h Show help.\n'
276 |
277 | try:
278 | opts, args = getopt.getopt(sys.argv[1:], "a:p:u:r:dh")
279 | except getopt.GetoptError:
280 | print(usage)
281 | sys.exit(2)
282 |
283 | for opt, arg in opts:
284 | if opt == '-h':
285 | print(usage)
286 | sys.exit()
287 |
288 | elif opt in ("-d"):
289 | delete_connections = True
290 |
291 | elif opt in ("-r"):
292 | rcode = arg
293 |
294 | elif opt in ("-a"):
295 | address = arg
296 |
297 | elif opt in ("-p"):
298 | port = string_to_int(arg, port)
299 |
300 | elif opt in ("-u"):
301 | ui_path = arg
302 |
303 | print(f'Address={address}')
304 | print(f'Port={port}')
305 | print(f'UI path={ui_path}')
306 | print(f'Device registration code={rcode}')
307 | print(f'Delete Connections={delete_connections}')
308 | main(address, port, ui_path, rcode, delete_connections)
309 |
310 |
311 |
--------------------------------------------------------------------------------
/src/netman.py:
--------------------------------------------------------------------------------
1 | # Start a local hotspot using NetworkManager.
2 |
3 | # You must use https://developer.gnome.org/NetworkManager/1.2/spec.html
4 | # to see the DBUS API that the python-NetworkManager module is communicating
5 | # over (the module documentation is scant).
6 |
7 | import NetworkManager
8 | import uuid, os, sys, time, socket
9 |
10 | HOTSPOT_CONNECTION_NAME = 'hotspot'
11 | GENERIC_CONNECTION_NAME = 'python-wifi-connect'
12 |
13 |
14 | #------------------------------------------------------------------------------
15 | # Returns True if we are connected to the internet, False otherwise.
16 | def have_active_internet_connection(host="8.8.8.8", port=53, timeout=2):
17 | """
18 | Host: 8.8.8.8 (google-public-dns-a.google.com)
19 | OpenPort: 53/tcp
20 | Service: domain (DNS/TCP)
21 | """
22 | try:
23 | socket.setdefaulttimeout(timeout)
24 | socket.socket(socket.AF_INET, socket.SOCK_STREAM).connect((host, port))
25 | return True
26 | except Exception as e:
27 | #print(f"Exception: {e}")
28 | return False
29 |
30 |
31 | #------------------------------------------------------------------------------
32 | # Remove ALL wifi connections - to start clean or before running the hotspot.
33 | def delete_all_wifi_connections():
34 | # Get all known connections
35 | connections = NetworkManager.Settings.ListConnections()
36 |
37 | # Delete the '802-11-wireless' connections
38 | for connection in connections:
39 | if connection.GetSettings()["connection"]["type"] == "802-11-wireless":
40 | print("Deleting connection "
41 | + connection.GetSettings()["connection"]["id"]
42 | )
43 | connection.Delete()
44 | time.sleep(2)
45 |
46 |
47 | #------------------------------------------------------------------------------
48 | # Stop and delete the hotspot.
49 | # Returns True for success or False (for hotspot not found or error).
50 | def stop_hotspot():
51 | return stop_connection(HOTSPOT_CONNECTION_NAME)
52 |
53 |
54 | #------------------------------------------------------------------------------
55 | # Generic connection stopper / deleter.
56 | def stop_connection(conn_name=GENERIC_CONNECTION_NAME):
57 | # Find the hotspot connection
58 | try:
59 | connections = NetworkManager.Settings.ListConnections()
60 | connections = dict([(x.GetSettings()['connection']['id'], x) for x in connections])
61 | conn = connections[conn_name]
62 | conn.Delete()
63 | except Exception as e:
64 | #print(f'stop_hotspot error {e}')
65 | return False
66 | time.sleep(2)
67 | return True
68 |
69 |
70 | #------------------------------------------------------------------------------
71 | # Return a list of available SSIDs and their security type,
72 | # or [] for none available or error.
73 | def get_list_of_access_points():
74 | # bit flags we use when decoding what we get back from NetMan for each AP
75 | NM_SECURITY_NONE = 0x0
76 | NM_SECURITY_WEP = 0x1
77 | NM_SECURITY_WPA = 0x2
78 | NM_SECURITY_WPA2 = 0x4
79 | NM_SECURITY_ENTERPRISE = 0x8
80 |
81 | ssids = [] # list we return
82 |
83 | for dev in NetworkManager.NetworkManager.GetDevices():
84 | if dev.DeviceType != NetworkManager.NM_DEVICE_TYPE_WIFI:
85 | continue
86 | for ap in dev.GetAccessPoints():
87 |
88 | # Get Flags, WpaFlags and RsnFlags, all are bit OR'd combinations
89 | # of the NM_802_11_AP_SEC_* bit flags.
90 | # https://developer.gnome.org/NetworkManager/1.2/nm-dbus-types.html#NM80211ApSecurityFlags
91 |
92 | security = NM_SECURITY_NONE
93 |
94 | # Based on a subset of the flag settings we can determine which
95 | # type of security this AP uses.
96 | # We can also determine what input we need from the user to connect to
97 | # any given AP (required for our dynamic UI form).
98 | if ap.Flags & NetworkManager.NM_802_11_AP_FLAGS_PRIVACY and \
99 | ap.WpaFlags == NetworkManager.NM_802_11_AP_SEC_NONE and \
100 | ap.RsnFlags == NetworkManager.NM_802_11_AP_SEC_NONE:
101 | security = NM_SECURITY_WEP
102 |
103 | if ap.WpaFlags != NetworkManager.NM_802_11_AP_SEC_NONE:
104 | security = NM_SECURITY_WPA
105 |
106 | if ap.RsnFlags != NetworkManager.NM_802_11_AP_SEC_NONE:
107 | security = NM_SECURITY_WPA2
108 |
109 | if ap.WpaFlags & NetworkManager.NM_802_11_AP_SEC_KEY_MGMT_802_1X or \
110 | ap.RsnFlags & NetworkManager.NM_802_11_AP_SEC_KEY_MGMT_802_1X:
111 | security = NM_SECURITY_ENTERPRISE
112 |
113 | #print(f'{ap.Ssid:15} Flags=0x{ap.Flags:X} WpaFlags=0x{ap.WpaFlags:X} RsnFlags=0x{ap.RsnFlags:X}')
114 |
115 | # Decode our flag into a display string
116 | security_str = ''
117 | if security == NM_SECURITY_NONE:
118 | security_str = 'NONE'
119 |
120 | if security & NM_SECURITY_WEP:
121 | security_str = 'WEP'
122 |
123 | if security & NM_SECURITY_WPA:
124 | security_str = 'WPA'
125 |
126 | if security & NM_SECURITY_WPA2:
127 | security_str = 'WPA2'
128 |
129 | if security & NM_SECURITY_ENTERPRISE:
130 | security_str = 'ENTERPRISE'
131 |
132 | entry = {"ssid": ap.Ssid, "security": security_str}
133 |
134 | # Don't add duplicates to the list, issue #8
135 | if ssids.__contains__(entry):
136 | continue
137 |
138 | # Don't add other PFC's to the list!
139 | if ap.Ssid.startswith('PFC_EDU-'):
140 | continue
141 |
142 | ssids.append(entry)
143 |
144 | # always add a hidden place holder
145 | ssids.append({"ssid": "Enter a hidden WiFi name", "security": "HIDDEN"})
146 |
147 | print(f'Available SSIDs: {ssids}')
148 | return ssids
149 |
150 |
151 | #------------------------------------------------------------------------------
152 | # Get hotspot SSID name.
153 | def get_hotspot_SSID():
154 | return 'PFC_EDU-'+os.getenv('RESIN_DEVICE_NAME_AT_INIT','aged-cheese')
155 |
156 |
157 | #------------------------------------------------------------------------------
158 | # Start a local hotspot on the wifi interface.
159 | # Returns True for success, False for error.
160 | def start_hotspot():
161 | return connect_to_AP(CONN_TYPE_HOTSPOT, HOTSPOT_CONNECTION_NAME, \
162 | get_hotspot_SSID())
163 |
164 |
165 | #------------------------------------------------------------------------------
166 | # Supported connection types for the function below.
167 | CONN_TYPE_HOTSPOT = 'hotspot'
168 | CONN_TYPE_SEC_NONE = 'NONE' # MIT
169 | CONN_TYPE_SEC_PASSWORD = 'PASSWORD' # WPA, WPA2 and WEP
170 | CONN_TYPE_SEC_ENTERPRISE = 'ENTERPRISE' # MIT SECURE
171 |
172 |
173 | #------------------------------------------------------------------------------
174 | # Generic connect to the user selected AP function.
175 | # Returns True for success, or False.
176 | def connect_to_AP(conn_type=None, conn_name=GENERIC_CONNECTION_NAME, \
177 | ssid=None, username=None, password=None):
178 |
179 | #print(f"connect_to_AP conn_type={conn_type} conn_name={conn_name} ssid={ssid} username={username} password={password}")
180 |
181 | if conn_type is None or ssid is None:
182 | print(f'connect_to_AP() Error: Missing args conn_type or ssid')
183 | return False
184 |
185 | try:
186 | # This is the hotspot that we turn on, on the RPI so we can show our
187 | # captured portal to let the user select an AP and provide credentials.
188 | hotspot_dict = {
189 | '802-11-wireless': {'band': 'bg',
190 | 'mode': 'ap',
191 | 'ssid': ssid},
192 | 'connection': {'autoconnect': False,
193 | 'id': conn_name,
194 | 'interface-name': 'wlan0',
195 | 'type': '802-11-wireless',
196 | 'uuid': str(uuid.uuid4())},
197 | 'ipv4': {'address-data':
198 | [{'address': '192.168.42.1', 'prefix': 24}],
199 | 'addresses': [['192.168.42.1', 24, '0.0.0.0']],
200 | 'method': 'manual'},
201 | 'ipv6': {'method': 'auto'}
202 | }
203 |
204 | #debugrob: is this realy a generic ENTERPRISE config, need another?
205 | #debugrob: how do we handle connecting to a captured portal?
206 |
207 | # This is what we use for "MIT SECURE" network.
208 | enterprise_dict = {
209 | '802-11-wireless': {'mode': 'infrastructure',
210 | 'security': '802-11-wireless-security',
211 | 'ssid': ssid},
212 | '802-11-wireless-security':
213 | {'auth-alg': 'open', 'key-mgmt': 'wpa-eap'},
214 | '802-1x': {'eap': ['peap'],
215 | 'identity': username,
216 | 'password': password,
217 | 'phase2-auth': 'mschapv2'},
218 | 'connection': {'id': conn_name,
219 | 'type': '802-11-wireless',
220 | 'uuid': str(uuid.uuid4())},
221 | 'ipv4': {'method': 'auto'},
222 | 'ipv6': {'method': 'auto'}
223 | }
224 |
225 | # No auth, 'open' connection.
226 | none_dict = {
227 | '802-11-wireless': {'mode': 'infrastructure',
228 | 'ssid': ssid},
229 | 'connection': {'id': conn_name,
230 | 'type': '802-11-wireless',
231 | 'uuid': str(uuid.uuid4())},
232 | 'ipv4': {'method': 'auto'},
233 | 'ipv6': {'method': 'auto'}
234 | }
235 |
236 | # Hidden, WEP, WPA, WPA2, password required.
237 | passwd_dict = {
238 | '802-11-wireless': {'mode': 'infrastructure',
239 | 'security': '802-11-wireless-security',
240 | 'ssid': ssid},
241 | '802-11-wireless-security':
242 | {'key-mgmt': 'wpa-psk', 'psk': password},
243 | 'connection': {'id': conn_name,
244 | 'type': '802-11-wireless',
245 | 'uuid': str(uuid.uuid4())},
246 | 'ipv4': {'method': 'auto'},
247 | 'ipv6': {'method': 'auto'}
248 | }
249 |
250 | conn_dict = None
251 | conn_str = ''
252 | if conn_type == CONN_TYPE_HOTSPOT:
253 | conn_dict = hotspot_dict
254 | conn_str = 'HOTSPOT'
255 |
256 | if conn_type == CONN_TYPE_SEC_NONE:
257 | conn_dict = none_dict
258 | conn_str = 'OPEN'
259 |
260 | if conn_type == CONN_TYPE_SEC_PASSWORD:
261 | conn_dict = passwd_dict
262 | conn_str = 'WEP/WPA/WPA2'
263 |
264 | if conn_type == CONN_TYPE_SEC_ENTERPRISE:
265 | conn_dict = enterprise_dict
266 | conn_str = 'ENTERPRISE'
267 |
268 | if conn_dict is None:
269 | print(f'connect_to_AP() Error: Invalid conn_type="{conn_type}"')
270 | return False
271 |
272 | #print(f"new connection {conn_dict} type={conn_str}")
273 |
274 | NetworkManager.Settings.AddConnection(conn_dict)
275 | print(f"Added connection {conn_name} of type {conn_str}")
276 |
277 | # Now find this connection and its device
278 | connections = NetworkManager.Settings.ListConnections()
279 | connections = dict([(x.GetSettings()['connection']['id'], x) for x in connections])
280 | conn = connections[conn_name]
281 |
282 | # Find a suitable device
283 | ctype = conn.GetSettings()['connection']['type']
284 | dtype = {'802-11-wireless': NetworkManager.NM_DEVICE_TYPE_WIFI}.get(ctype,ctype)
285 | devices = NetworkManager.NetworkManager.GetDevices()
286 |
287 | for dev in devices:
288 | if dev.DeviceType == dtype:
289 | break
290 | else:
291 | print(f"connect_to_AP() Error: No suitable and available {ctype} device found.")
292 | return False
293 |
294 | # And connect
295 | NetworkManager.NetworkManager.ActivateConnection(conn, dev, "/")
296 | print(f"Activated connection={conn_name}.")
297 |
298 | # Wait for ADDRCONF(NETDEV_CHANGE): wlan0: link becomes ready
299 | print(f'Waiting for connection to become active...')
300 | loop_count = 0
301 | while dev.State != NetworkManager.NM_DEVICE_STATE_ACTIVATED:
302 | #print(f'dev.State={dev.State}')
303 | time.sleep(1)
304 | loop_count += 1
305 | if loop_count > 30: # only wait 30 seconds max
306 | break
307 |
308 | if dev.State == NetworkManager.NM_DEVICE_STATE_ACTIVATED:
309 | print(f'Connection {conn_name} is live.')
310 | return True
311 |
312 | except Exception as e:
313 | print(f'Connection error {e}')
314 |
315 | print(f'Connection {conn_name} failed.')
316 | return False
317 |
318 |
319 |
320 |
321 |
--------------------------------------------------------------------------------
/ui/img/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OpenAgricultureFoundation/python-wifi-connect/2563fe088765f42f1137c4e1c8bbb54ba56916d3/ui/img/favicon.ico
--------------------------------------------------------------------------------
/ui/img/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OpenAgricultureFoundation/python-wifi-connect/2563fe088765f42f1137c4e1c8bbb54ba56916d3/ui/img/logo.png
--------------------------------------------------------------------------------
/ui/img/logo.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/ui/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | PFC_EDU WiFi Connect
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
32 |
33 |
34 |
35 |
42 |
43 |
44 |
45 |
46 |
47 |
Please write down this device registration code:
48 |
49 |
You will need it to add your device to your account in the next step.
50 |
51 |
52 |
53 |
54 |
55 |
Hi! Please choose your WiFi Network from the list.
56 |
57 |
58 |
59 |
60 |
61 |
97 |
98 |
99 |
100 |
101 |
102 |
Applying changes...
103 |
Your device will soon be online. If connection is unsuccessful, the Access Point will be back up in a few minutes.
104 |
105 |
106 |
107 |
108 |
109 |
No wifi networks available
110 |
Please ensure there is a network within range and reboot the device.