├── .github
└── workflows
│ └── pylint.yml
├── .gitignore
├── .pylintrc
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── assets
└── preview.png
├── build.py
└── src
├── api.py
├── boot.py
├── code.py
├── ducky.py
├── logs.py
├── payloads
└── boot.dd
├── settings.toml
└── static
├── index.html
├── main.css
└── script.js
/.github/workflows/pylint.yml:
--------------------------------------------------------------------------------
1 | name: Pylint
2 |
3 | on: [push]
4 |
5 | jobs:
6 | build:
7 | runs-on: ubuntu-latest
8 | strategy:
9 | matrix:
10 | python-version: ["3.8", "3.9", "3.10"]
11 | steps:
12 | - uses: actions/checkout@v3
13 | - name: Set up Python ${{ matrix.python-version }}
14 | uses: actions/setup-python@v3
15 | with:
16 | python-version: ${{ matrix.python-version }}
17 | - name: Install dependencies
18 | run: |
19 | python -m pip install --upgrade pip
20 | pip install pylint
21 | - name: Analysing the code with pylint
22 | run: |
23 | pylint $(git ls-files '*.py')
24 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | build
2 | *.uf2
3 | mpy-cross*
4 | adafruit-circuitpython-bundle*
5 |
--------------------------------------------------------------------------------
/.pylintrc:
--------------------------------------------------------------------------------
1 | # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
2 | #
3 | # SPDX-License-Identifier: Unlicense
4 |
5 | [MASTER]
6 |
7 | # A comma-separated list of package or module names from where C extensions may
8 | # be loaded. Extensions are loading into the active Python interpreter and may
9 | # run arbitrary code
10 | extension-pkg-whitelist=
11 |
12 | # Add files or directories to the ignore-list. They should be base names, not
13 | # paths.
14 | ignore=CVS
15 |
16 | # Add files or directories matching the regex patterns to the ignore-list. The
17 | # regex matches against base names, not paths.
18 | ignore-patterns=
19 |
20 | # Python code to execute, usually for sys.path manipulation such as
21 | # pygtk.require().
22 | #init-hook=
23 |
24 | # Use multiple processes to speed up Pylint.
25 | jobs=1
26 |
27 | # List of plugins (as comma separated values of python modules names) to load,
28 | # usually to register additional checkers.
29 | load-plugins=pylint.extensions.no_self_use
30 |
31 | # Pickle collected data for later comparisons.
32 | persistent=yes
33 |
34 | # Specify a configuration file.
35 | #rcfile=
36 |
37 | # Allow loading of arbitrary C extensions. Extensions are imported into the
38 | # active Python interpreter and may run arbitrary code.
39 | unsafe-load-any-extension=no
40 |
41 |
42 | [MESSAGES CONTROL]
43 |
44 | # Only show warnings with the listed confidence levels. Leave empty to show
45 | # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
46 | confidence=
47 |
48 | # Disable the message, report, category or checker with the given id(s). You
49 | # can either give multiple identifiers separated by comma (,) or put this
50 | # option multiple times (only on the command line, not in the configuration
51 | # file where it should appear only once).You can also use "--disable=all" to
52 | # disable everything first and then reenable specific checks. For example, if
53 | # you want to run only the similarities checker, you can use "--disable=all
54 | # --enable=similarities". If you want to run only the classes checker, but have
55 | # no Warning level messages displayed, use"--disable=all --enable=classes
56 | # --disable=W"
57 | # disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call
58 | disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding
59 |
60 | # Enable the message, report, category or checker with the given id(s). You can
61 | # either give multiple identifier separated by comma (,) or put this option
62 | # multiple time (only on the command line, not in the configuration file where
63 | # it should appear only once). See also the "--disable" option for examples.
64 | enable=
65 |
66 |
67 | [REPORTS]
68 |
69 | # Python expression which should return a note less than 10 (10 is the highest
70 | # note). You have access to the variables errors warning, statement which
71 | # respectively contain the number of errors / warnings messages and the total
72 | # number of statements analyzed. This is used by the global evaluation report
73 | # (RP0004).
74 | evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
75 |
76 | # Template used to display messages. This is a python new-style format string
77 | # used to format the message information. See doc for all details
78 | #msg-template=
79 |
80 | # Set the output format. Available formats are text, parseable, colorized, json
81 | # and msvs (visual studio).You can also give a reporter class, eg
82 | # mypackage.mymodule.MyReporterClass.
83 | output-format=text
84 |
85 | # Tells whether to display a full report or only the messages
86 | reports=no
87 |
88 | # Activate the evaluation score.
89 | score=yes
90 |
91 |
92 | [REFACTORING]
93 |
94 | # Maximum number of nested blocks for function / method body
95 | max-nested-blocks=5
96 |
97 |
98 | [LOGGING]
99 |
100 | # Logging modules to check that the string format arguments are in logging
101 | # function parameter format
102 | logging-modules=logging
103 |
104 |
105 | [SPELLING]
106 |
107 | # Spelling dictionary name. Available dictionaries: none. To make it working
108 | # install python-enchant package.
109 | spelling-dict=
110 |
111 | # List of comma separated words that should not be checked.
112 | spelling-ignore-words=
113 |
114 | # A path to a file that contains private dictionary; one word per line.
115 | spelling-private-dict-file=
116 |
117 | # Tells whether to store unknown words to indicated private dictionary in
118 | # --spelling-private-dict-file option instead of raising a message.
119 | spelling-store-unknown-words=no
120 |
121 |
122 | [MISCELLANEOUS]
123 |
124 | # List of note tags to take in consideration, separated by a comma.
125 | # notes=FIXME,XXX,TODO
126 | notes=FIXME,XXX
127 |
128 |
129 | [TYPECHECK]
130 |
131 | # List of decorators that produce context managers, such as
132 | # contextlib.contextmanager. Add to this list to register other decorators that
133 | # produce valid context managers.
134 | contextmanager-decorators=contextlib.contextmanager
135 |
136 | # List of members which are set dynamically and missed by pylint inference
137 | # system, and so shouldn't trigger E1101 when accessed. Python regular
138 | # expressions are accepted.
139 | generated-members=
140 |
141 | # Tells whether missing members accessed in mixin class should be ignored. A
142 | # mixin class is detected if its name ends with "mixin" (case insensitive).
143 | ignore-mixin-members=yes
144 |
145 | # This flag controls whether pylint should warn about no-member and similar
146 | # checks whenever an opaque object is returned when inferring. The inference
147 | # can return multiple potential results while evaluating a Python object, but
148 | # some branches might not be evaluated, which results in partial inference. In
149 | # that case, it might be useful to still emit no-member and other checks for
150 | # the rest of the inferred objects.
151 | ignore-on-opaque-inference=yes
152 |
153 | # List of class names for which member attributes should not be checked (useful
154 | # for classes with dynamically set attributes). This supports the use of
155 | # qualified names.
156 | ignored-classes=optparse.Values,thread._local,_thread._local
157 |
158 | # List of module names for which member attributes should not be checked
159 | # (useful for modules/projects where namespaces are manipulated during runtime
160 | # and thus existing member attributes cannot be deduced by static analysis. It
161 | # supports qualified module names, as well as Unix pattern matching.
162 | ignored-modules=board
163 |
164 | # Show a hint with possible names when a member name was not found. The aspect
165 | # of finding the hint is based on edit distance.
166 | missing-member-hint=yes
167 |
168 | # The minimum edit distance a name should have in order to be considered a
169 | # similar match for a missing member name.
170 | missing-member-hint-distance=1
171 |
172 | # The total number of similar names that should be taken in consideration when
173 | # showing a hint for a missing member.
174 | missing-member-max-choices=1
175 |
176 |
177 | [VARIABLES]
178 |
179 | # List of additional names supposed to be defined in builtins. Remember that
180 | # you should avoid to define new builtins when possible.
181 | additional-builtins=
182 |
183 | # Tells whether unused global variables should be treated as a violation.
184 | allow-global-unused-variables=yes
185 |
186 | # List of strings which can identify a callback function by name. A callback
187 | # name must start or end with one of those strings.
188 | callbacks=cb_,_cb
189 |
190 | # A regular expression matching the name of dummy variables (i.e. expectedly
191 | # not used).
192 | dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
193 |
194 | # Argument names that match this expression will be ignored. Default to name
195 | # with leading underscore
196 | ignored-argument-names=_.*|^ignored_|^unused_
197 |
198 | # Tells whether we should check for unused import in __init__ files.
199 | init-import=no
200 |
201 | # List of qualified module names which can have objects that can redefine
202 | # builtins.
203 | redefining-builtins-modules=six.moves,future.builtins
204 |
205 |
206 | [FORMAT]
207 |
208 | # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
209 | # expected-line-ending-format=
210 | expected-line-ending-format=LF
211 |
212 | # Regexp for a line that is allowed to be longer than the limit.
213 | ignore-long-lines=^\s*(# )??$
214 |
215 | # Number of spaces of indent required inside a hanging or continued line.
216 | indent-after-paren=4
217 |
218 | # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
219 | # tab).
220 | indent-string=' '
221 |
222 | # Maximum number of characters on a single line.
223 | max-line-length=100
224 |
225 | # Maximum number of lines in a module
226 | max-module-lines=1000
227 |
228 | # Allow the body of a class to be on the same line as the declaration if body
229 | # contains single statement.
230 | single-line-class-stmt=no
231 |
232 | # Allow the body of an if to be on the same line as the test if there is no
233 | # else.
234 | single-line-if-stmt=no
235 |
236 |
237 | [SIMILARITIES]
238 |
239 | # Ignore comments when computing similarities.
240 | ignore-comments=yes
241 |
242 | # Ignore docstrings when computing similarities.
243 | ignore-docstrings=yes
244 |
245 | # Ignore imports when computing similarities.
246 | ignore-imports=yes
247 |
248 | # Minimum lines number of a similarity.
249 | min-similarity-lines=12
250 |
251 |
252 | [BASIC]
253 |
254 | # Regular expression matching correct argument names
255 | argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
256 |
257 | # Regular expression matching correct attribute names
258 | attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
259 |
260 | # Bad variable names which should always be refused, separated by a comma
261 | bad-names=foo,bar,baz,toto,tutu,tata
262 |
263 | # Regular expression matching correct class attribute names
264 | class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
265 |
266 | # Regular expression matching correct class names
267 | # class-rgx=[A-Z_][a-zA-Z0-9]+$
268 | class-rgx=[A-Z_][a-zA-Z0-9_]+$
269 |
270 | # Regular expression matching correct constant names
271 | const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
272 |
273 | # Minimum line length for functions/classes that require docstrings, shorter
274 | # ones are exempt.
275 | docstring-min-length=-1
276 |
277 | # Regular expression matching correct function names
278 | function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
279 |
280 | # Good variable names which should always be accepted, separated by a comma
281 | # good-names=i,j,k,ex,Run,_
282 | good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
283 |
284 | # Include a hint for the correct naming format with invalid-name
285 | include-naming-hint=no
286 |
287 | # Regular expression matching correct inline iteration names
288 | inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
289 |
290 | # Regular expression matching correct method names
291 | method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
292 |
293 | # Regular expression matching correct module names
294 | module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
295 |
296 | # Colon-delimited sets of names that determine each other's naming style when
297 | # the name regexes allow several styles.
298 | name-group=
299 |
300 | # Regular expression which should only match function or class names that do
301 | # not require a docstring.
302 | no-docstring-rgx=^_
303 |
304 | # List of decorators that produce properties, such as abc.abstractproperty. Add
305 | # to this list to register other decorators that produce valid properties.
306 | property-classes=abc.abstractproperty
307 |
308 | # Regular expression matching correct variable names
309 | variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
310 |
311 |
312 | [IMPORTS]
313 |
314 | # Allow wildcard imports from modules that define __all__.
315 | allow-wildcard-with-all=no
316 |
317 | # Analyse import fallback blocks. This can be used to support both Python 2 and
318 | # 3 compatible code, which means that the block might have code that exists
319 | # only in one or another interpreter, leading to false positives when analysed.
320 | analyse-fallback-blocks=no
321 |
322 | # Deprecated modules which should not be used, separated by a comma
323 | deprecated-modules=optparse,tkinter.tix
324 |
325 | # Create a graph of external dependencies in the given file (report RP0402 must
326 | # not be disabled)
327 | ext-import-graph=
328 |
329 | # Create a graph of every (i.e. internal and external) dependencies in the
330 | # given file (report RP0402 must not be disabled)
331 | import-graph=
332 |
333 | # Create a graph of internal dependencies in the given file (report RP0402 must
334 | # not be disabled)
335 | int-import-graph=
336 |
337 | # Force import order to recognize a module as part of the standard
338 | # compatibility libraries.
339 | known-standard-library=
340 |
341 | # Force import order to recognize a module as part of a third party library.
342 | known-third-party=enchant
343 |
344 |
345 | [CLASSES]
346 |
347 | # List of method names used to declare (i.e. assign) instance attributes.
348 | defining-attr-methods=__init__,__new__,setUp
349 |
350 | # List of member names, which should be excluded from the protected access
351 | # warning.
352 | exclude-protected=_asdict,_fields,_replace,_source,_make
353 |
354 | # List of valid names for the first argument in a class method.
355 | valid-classmethod-first-arg=cls
356 |
357 | # List of valid names for the first argument in a metaclass class method.
358 | valid-metaclass-classmethod-first-arg=mcs
359 |
360 |
361 | [DESIGN]
362 |
363 | # Maximum number of arguments for function / method
364 | max-args=5
365 |
366 | # Maximum number of attributes for a class (see R0902).
367 | # max-attributes=7
368 | max-attributes=11
369 |
370 | # Maximum number of boolean expressions in a if statement
371 | max-bool-expr=5
372 |
373 | # Maximum number of branch for function / method body
374 | max-branches=12
375 |
376 | # Maximum number of locals for function / method body
377 | max-locals=15
378 |
379 | # Maximum number of parents for a class (see R0901).
380 | max-parents=7
381 |
382 | # Maximum number of public methods for a class (see R0904).
383 | max-public-methods=20
384 |
385 | # Maximum number of return / yield for function / method body
386 | max-returns=6
387 |
388 | # Maximum number of statements in function / method body
389 | max-statements=50
390 |
391 | # Minimum number of public methods for a class (see R0903).
392 | min-public-methods=1
393 |
394 |
395 | [EXCEPTIONS]
396 |
397 | # Exceptions that will emit a warning when being caught. Defaults to
398 | # "Exception"
399 | overgeneral-exceptions=builtins.Exception
400 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 |
2 | # Contributor Covenant Code of Conduct
3 |
4 | ## Our Pledge
5 |
6 | We as members, contributors, and leaders pledge to make participation in our
7 | community a harassment-free experience for everyone, regardless of age, body
8 | size, visible or invisible disability, ethnicity, sex characteristics, gender
9 | identity and expression, level of experience, education, socio-economic status,
10 | nationality, personal appearance, race, caste, color, religion, or sexual
11 | identity and orientation.
12 |
13 | We pledge to act and interact in ways that contribute to an open, welcoming,
14 | diverse, inclusive, and healthy community.
15 |
16 | ## Our Standards
17 |
18 | Examples of behavior that contributes to a positive environment for our
19 | community include:
20 |
21 | * Demonstrating empathy and kindness toward other people
22 | * Being respectful of differing opinions, viewpoints, and experiences
23 | * Giving and gracefully accepting constructive feedback
24 | * Accepting responsibility and apologizing to those affected by our mistakes,
25 | and learning from the experience
26 | * Focusing on what is best not just for us as individuals, but for the overall
27 | community
28 |
29 | Examples of unacceptable behavior include:
30 |
31 | * The use of sexualized language or imagery, and sexual attention or advances of
32 | any kind
33 | * Trolling, insulting or derogatory comments, and personal or political attacks
34 | * Public or private harassment
35 | * Publishing others' private information, such as a physical or email address,
36 | without their explicit permission
37 | * Other conduct which could reasonably be considered inappropriate in a
38 | professional setting
39 |
40 | ## Enforcement Responsibilities
41 |
42 | Community leaders are responsible for clarifying and enforcing our standards of
43 | acceptable behavior and will take appropriate and fair corrective action in
44 | response to any behavior that they deem inappropriate, threatening, offensive,
45 | or harmful.
46 |
47 | Community leaders have the right and responsibility to remove, edit, or reject
48 | comments, commits, code, wiki edits, issues, and other contributions that are
49 | not aligned to this Code of Conduct, and will communicate reasons for moderation
50 | decisions when appropriate.
51 |
52 | ## Scope
53 |
54 | This Code of Conduct applies within all community spaces, and also applies when
55 | an individual is officially representing the community in public spaces.
56 | Examples of representing our community include using an official e-mail address,
57 | posting via an official social media account, or acting as an appointed
58 | representative at an online or offline event.
59 |
60 | ## Enforcement
61 |
62 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
63 | reported to the community leaders responsible for enforcement at
64 | [lavafroth@protonmail.com](mailto:lavafroth@protonmail.com).
65 | All complaints will be reviewed and investigated promptly and fairly.
66 |
67 | All community leaders are obligated to respect the privacy and security of the
68 | reporter of any incident.
69 |
70 | ## Enforcement Guidelines
71 |
72 | Community leaders will follow these Community Impact Guidelines in determining
73 | the consequences for any action they deem in violation of this Code of Conduct:
74 |
75 | ### 1. Correction
76 |
77 | **Community Impact**: Use of inappropriate language or other behavior deemed
78 | unprofessional or unwelcome in the community.
79 |
80 | **Consequence**: A private, written warning from community leaders, providing
81 | clarity around the nature of the violation and an explanation of why the
82 | behavior was inappropriate. A public apology may be requested.
83 |
84 | ### 2. Warning
85 |
86 | **Community Impact**: A violation through a single incident or series of
87 | actions.
88 |
89 | **Consequence**: A warning with consequences for continued behavior. No
90 | interaction with the people involved, including unsolicited interaction with
91 | those enforcing the Code of Conduct, for a specified period of time. This
92 | includes avoiding interactions in community spaces as well as external channels
93 | like social media. Violating these terms may lead to a temporary or permanent
94 | ban.
95 |
96 | ### 3. Temporary Ban
97 |
98 | **Community Impact**: A serious violation of community standards, including
99 | sustained inappropriate behavior.
100 |
101 | **Consequence**: A temporary ban from any sort of interaction or public
102 | communication with the community for a specified period of time. No public or
103 | private interaction with the people involved, including unsolicited interaction
104 | with those enforcing the Code of Conduct, is allowed during this period.
105 | Violating these terms may lead to a permanent ban.
106 |
107 | ### 4. Permanent Ban
108 |
109 | **Community Impact**: Demonstrating a pattern of violation of community
110 | standards, including sustained inappropriate behavior, harassment of an
111 | individual, or aggression toward or disparagement of classes of individuals.
112 |
113 | **Consequence**: A permanent ban from any sort of public interaction within the
114 | community.
115 |
116 | ## Attribution
117 |
118 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119 | version 2.1, available at
120 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121 |
122 | Community Impact Guidelines were inspired by
123 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124 |
125 | For answers to common questions about this code of conduct, see the FAQ at
126 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127 | [https://www.contributor-covenant.org/translations][translations].
128 |
129 | [homepage]: https://www.contributor-covenant.org
130 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131 | [Mozilla CoC]: https://github.com/mozilla/diversity
132 | [FAQ]: https://www.contributor-covenant.org/faq
133 | [translations]: https://www.contributor-covenant.org/translations
134 |
135 |
--------------------------------------------------------------------------------
/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 | # PwnPi - A More Offensive Redteam Appliance
2 |
3 | PwnPi Amora is a wireless keystroke injection tool built on the Raspberry Pi Pico W using CircuitPython.
4 |
5 | The project makes an attempt to provide a fully featured web IDE for building
6 | and deploying keystroke injection scripts.
7 |
8 | 
9 |
10 | ## Getting Started
11 |
12 | Check out the [wiki](https://github.com/lavafroth/pwnpi-amora/wiki/) for getting started.
13 |
--------------------------------------------------------------------------------
/assets/preview.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lavafroth/pwnpi-amora/919a9092b6346a8984da1b47dcafa99d5adeb8e9/assets/preview.png
--------------------------------------------------------------------------------
/build.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 | """
3 | Builder script to compile .py files to .mpy bytecode using mpy-cross
4 | """
5 |
6 | import glob
7 | from errno import ENOTDIR
8 | from os import listdir, makedirs
9 | from os.path import join, splitext
10 | from shutil import copy, copytree, rmtree
11 | from subprocess import PIPE, Popen
12 |
13 | SRC = "src"
14 | DST = "build"
15 |
16 |
17 | def recursive_copy(src: str, dst: str):
18 | """
19 | Copy a file or directory from src to dst.
20 |
21 | Parameters:
22 | src (str): The path of the source file or directory.
23 | dst (str): The path of the destination file or directory.
24 |
25 | Returns:
26 | None
27 | """
28 | try:
29 | copytree(src, dst)
30 | except OSError as exc:
31 | if exc.errno == ENOTDIR:
32 | copy(src, dst)
33 | else:
34 | raise
35 |
36 |
37 | def to_compile(name: str) -> str:
38 | """
39 | Check if a given file is a Python source file that needs to be compiled.
40 |
41 | Parameters:
42 | name (str): The name of the file.
43 |
44 | Returns:
45 | str: The name of the file without the extension if it need compilation,
46 | otherwise None.
47 | """
48 | base, ext = splitext(name)
49 | if base not in ("code", "boot") and ext == ".py":
50 | return base
51 | return None
52 |
53 |
54 | def main():
55 | """
56 | Use mpy-cross to compile .py files to .mpy bytecode
57 | """
58 |
59 | # Remove the build directory if it exists, then create it again
60 | rmtree(DST, ignore_errors=True)
61 | makedirs(DST, exist_ok=True)
62 | makedirs(join(DST, "lib"), exist_ok=True)
63 |
64 | # Find the path of the mpy-cross binary
65 | mpy_cross_bin = join(".", glob.glob("mpy-cross.static*")[0])
66 |
67 | # Process each entry in the source directory
68 | for entry in listdir(SRC):
69 | src_path = join(SRC, entry)
70 | # If the entry is a Python source file that needs to be compiled
71 | if name := to_compile(entry):
72 | # Compile the file using mpy-cross
73 | with Popen(
74 | [mpy_cross_bin, "-o",
75 | join(DST, "lib", f"{name}.mpy"), src_path],
76 | stdout=PIPE,
77 | ) as process:
78 | process.communicate()
79 | else:
80 | # Copy the file or directory to the build directory
81 | dst_path = join(DST, entry)
82 | recursive_copy(src_path, dst_path)
83 |
84 |
85 | if __name__ == "__main__":
86 | main()
87 |
--------------------------------------------------------------------------------
/src/api.py:
--------------------------------------------------------------------------------
1 | """
2 | Handler code to interact with the backend for each incoming web request
3 | """
4 | import os
5 |
6 | from adafruit_httpserver import JSONResponse, Request
7 |
8 | import logs
9 | from ducky import run_script, run_script_file
10 |
11 |
12 | def create(path, contents=b""):
13 | """
14 | Create a new payload file, optionally with content to write to it.
15 | """
16 | with open(path, "wb") as file:
17 | file.write(contents)
18 |
19 |
20 | def handle(request: Request):
21 | """
22 | Handle all the API requests from the web interface like
23 | create, load, store, delete and run.
24 | """
25 | body = request.json()
26 | action = body["action"]
27 | if action == "list":
28 | return JSONResponse(request, os.listdir("payloads"))
29 |
30 | if action == "logs":
31 | return JSONResponse(request, logs.consume())
32 |
33 | filename = body.get("filename")
34 | path = f"payloads/{filename}"
35 | if action == "load":
36 | with open(path) as file:
37 | return JSONResponse(request, {"contents": file.read()})
38 | elif action == "store":
39 | create(path, body["contents"].encode())
40 | elif action == "delete":
41 | os.remove(path)
42 | elif action == "create":
43 | create(path)
44 | elif action == "run":
45 | if filename is not None:
46 | run_script_file(path)
47 | elif contents := body["contents"]:
48 | run_script(contents)
49 | return JSONResponse(request, {})
50 |
--------------------------------------------------------------------------------
/src/boot.py:
--------------------------------------------------------------------------------
1 | """
2 | Disable concurrent write protections on the storage.
3 | This is especially necessary for dev builds since we need to change the files
4 | on the board for hot reloading.
5 | """
6 |
7 | import storage
8 |
9 | storage.remount("/", readonly=False, disable_concurrent_write_protection=True)
10 |
--------------------------------------------------------------------------------
/src/code.py:
--------------------------------------------------------------------------------
1 | """
2 | The entrypoint for our circuitpython board.
3 | """
4 |
5 | import asyncio
6 | import os
7 |
8 | import microcontroller
9 | import socketpool
10 | import wifi
11 | from adafruit_httpserver import POST, FileResponse, Request, Server
12 | from ducky import run_boot_script
13 |
14 | from api import handle
15 |
16 | async def setup_server():
17 | """
18 | Begin a wifi access point defined by the SSID and PASSWORD environment
19 | variables.
20 | Spawn a socketpool on this interface.
21 | Serve the web interface over this socketpool indefinitely using an HTTP
22 | server.
23 | """
24 | wifi.radio.start_ap(ssid=os.getenv("SSID"), password=os.getenv("PASSWORD"))
25 | pool = socketpool.SocketPool(wifi.radio)
26 | server = Server(pool)
27 |
28 | @server.route("/")
29 | def base(request: Request):
30 | return FileResponse(request, "index.html", root_path="/static")
31 |
32 | @server.route("/main.css")
33 | def css(request: Request):
34 | return FileResponse(request, "main.css", root_path="/static")
35 |
36 | @server.route("/script.js")
37 | def javascript(request: Request):
38 | return FileResponse(request, "script.js", root_path="/static")
39 |
40 | @server.route("/api", POST)
41 | def api(request: Request):
42 | return handle(request)
43 |
44 | server.serve_forever(str(wifi.radio.ipv4_address_ap))
45 |
46 |
47 | async def main():
48 | """
49 | Asynchronously run the boot script while setting
50 | the server up for the web interface.
51 | """
52 | await asyncio.gather(
53 | run_boot_script(),
54 | setup_server()
55 | )
56 |
57 |
58 | if __name__ == "__main__":
59 | try:
60 | asyncio.run(main())
61 | # For some reason, wifi.stop_ap is not implemented.
62 | except NotImplementedError:
63 | microcontroller.reset()
64 |
--------------------------------------------------------------------------------
/src/ducky.py:
--------------------------------------------------------------------------------
1 | """
2 | Logic to interpret and execute user defined ducky script payloads.
3 | """
4 | import time
5 |
6 | import usb_hid
7 | from adafruit_hid.keyboard import Keyboard
8 |
9 | # comment out these lines for non_US keyboards
10 | from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS as KeyboardLayout
11 | from adafruit_hid.keycode import Keycode
12 | from board import LED
13 |
14 | from logs import info, warn
15 |
16 | # uncomment these lines for non_US keyboards
17 | # replace LANG with appropriate language
18 | # from keyboard_layout_win_LANG import KeyboardLayout
19 | # from keycode_win_LANG import Keycode
20 |
21 |
22 | kbd = Keyboard(usb_hid.devices)
23 | layout = KeyboardLayout(kbd)
24 |
25 |
26 | def delay(millis):
27 | """
28 | Sleep, do absolutely nothing.
29 | """
30 | time.sleep(float(millis) / 1000)
31 |
32 |
33 | def prefix_checker(line: str):
34 | """
35 | Returns a function that checks if line begins with
36 | any of the prefixes supplied to it.
37 |
38 | Syntax sugar so that we can later use it in conditional
39 | statements like if something := checker("foo", "bar")
40 | """
41 |
42 | def checker(*prefixes):
43 | for prefix in prefixes:
44 | if line.startswith(prefix):
45 | return line[len(prefix) + 1:]
46 | return None
47 |
48 | return checker
49 |
50 |
51 | def press_keys(line: str):
52 | """
53 | Press all the keys and then release them.
54 | Really useful for keyboard shortcuts like Meta+R.
55 | """
56 | # loop on each key filtering empty values
57 | for key in filter(None, line.upper().split(" ")):
58 | if command_keycode := Keycode.__dict__.get(key):
59 | # If this is a valid key, send its keycode
60 | kbd.press(command_keycode)
61 | continue
62 | # If it's not a known key name, log it for diagnosis
63 | warn(f"unknown key: <{key}>")
64 | kbd.release_all()
65 |
66 |
67 | def repeat(contents: str, times: int):
68 | """
69 | If the contents supplied is not empty or None,
70 | repeat those ducky script lines `times` times.
71 | """
72 | if not contents:
73 | return
74 | for _ in range(times):
75 | run_script(contents)
76 |
77 |
78 | def run_script(contents):
79 | """
80 | Interpret the ducky script and execute it line by line
81 | """
82 | default_delay = 0
83 | previous_line = None
84 | for line in filter(None, contents.splitlines()):
85 | line = line.rstrip()
86 | after = prefix_checker(line)
87 |
88 | if times := after("REPEAT"):
89 | repeat(previous_line, int(times))
90 |
91 | elif after("REM"):
92 | continue
93 | elif (millis := after("DELAY")) is not None:
94 | delay(millis or default_delay)
95 | elif message := after("PRINT"):
96 | info(message)
97 | elif path := after("IMPORT"):
98 | run_script_file(path)
99 | elif millis := after("DEFAULT_DELAY", "DEFAULTDELAY"):
100 | default_delay = int(millis)
101 | elif after("LED") is not None:
102 | LED.value ^= True
103 | elif string := after("STRING"):
104 | layout.write(string)
105 | else:
106 | press_keys(line)
107 |
108 | previous_line = line
109 | delay(default_delay)
110 |
111 |
112 | def run_script_file(path: str):
113 | """
114 | Try reading and running a ducky script from the supplied path.
115 | """
116 | try:
117 | with open(path, "r", encoding="utf-8") as handle:
118 | run_script(handle.read())
119 | except OSError as error:
120 | warn(f"unable to open file {path}: {error}")
121 |
122 |
123 | async def run_boot_script():
124 | """
125 | If a script with the name 'boot.dd' exists,
126 | run it without user interaction on boot.
127 | """
128 | try:
129 | with open("payloads/boot.dd", "r", encoding="utf-8") as handle:
130 | run_script(handle.read())
131 | except OSError:
132 | info("boot script does not exist, skipping its execution")
133 |
--------------------------------------------------------------------------------
/src/logs.py:
--------------------------------------------------------------------------------
1 | """
2 | A very bare-bones logging implementation
3 | for the bottom pane of the Web UI.
4 | """
5 |
6 | logs = []
7 |
8 |
9 | def consume() -> str:
10 | """
11 | Convert all the log entries from the module's global mutable
12 | list to json return them, clearing the list after the dump.
13 | """
14 | dump = logs.copy()
15 | logs.clear()
16 | return dump
17 |
18 |
19 | def info(message: str):
20 | """
21 | Add a log entry with the message prepended with the info marker
22 | """
23 | logs.append("info: " + message)
24 |
25 |
26 | def warn(message: str):
27 | """
28 | Add a log entry with the message prepended with the warning marker
29 | """
30 | logs.append("warning: " + message)
31 |
--------------------------------------------------------------------------------
/src/payloads/boot.dd:
--------------------------------------------------------------------------------
1 | STRING Hello PwnPi!
2 |
--------------------------------------------------------------------------------
/src/settings.toml:
--------------------------------------------------------------------------------
1 | SSID="amora"
2 | PASSWORD="pwnpiamora"
3 |
--------------------------------------------------------------------------------
/src/static/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 | amora
10 |
11 |
12 |
13 |