Repository: errbufferoverfl/usb-canary
Branch: master
Commit: bb235520b0b3
Files: 29
Total size: 81.5 KB
Directory structure:
gitextract_9p5qbzdt/
├── .gitignore
├── .travis.yml
├── CONTRIBUTING.md
├── ISSUE_TEMPLATE.md
├── LICENSE.txt
├── PULL_REQUEST_TEMPLATE.md
├── README.md
├── canary/
│ ├── __init__.py
│ ├── helpers.py
│ ├── message_handler.py
│ ├── operating_system/
│ │ ├── __init__.py
│ │ ├── darwin.py
│ │ ├── helpers.py
│ │ └── linux.py
│ ├── pushovr/
│ │ ├── __init__.py
│ │ └── pushover.py
│ ├── screensaver/
│ │ ├── __init__.py
│ │ ├── gnome_screensaver.py
│ │ ├── helpers.py
│ │ └── xscreensaver.py
│ ├── settings.py
│ ├── slack/
│ │ ├── __init__.py
│ │ ├── slack.py
│ │ └── slack_bot.py
│ └── twilleo/
│ ├── __init__.py
│ └── twilleo.py
├── requirements.txt
├── settings.json
└── usbcanary.py
================================================
FILE CONTENTS
================================================
================================================
FILE: .gitignore
================================================
# IntelliJ project files
.idea
.DS_Store
*.pyc
================================================
FILE: .travis.yml
================================================
sudo: false
dist: trusty
language: python
cache: pip
python:
- "2.7.13"
- "3.6"
install:
- pip install --upgrade pip setuptools
- pip install flake8
before_script:
flake8 . --count --max-line-length=127 --statistics # 127 == GitHub editor width
script:
flake8 . --count --max-line-length=127 --select=E999 # Stop build on syntax errors
notifications:
on_success: change
on_failure: always
================================================
FILE: CONTRIBUTING.md
================================================
# Contributing
First off, thank you for considering contributing to USB Canary.
### 1. Where do I go from here?
If you've noticed a bug or have a question [search the issue tracker](https://github.com/probablynotablog/usb-canary/issues)
to see if someone else in the community has already created a ticket. If not, go ahead and [make one](https://github.com/probablynotablog/usb-canary/issues/new)!
### 2. Fork & create a branch
If this is something you think you can fix, then [fork USB Canary](https://help.github.com/articles/fork-a-repo)
and create a branch with a descriptive name.
A good branch name would be (where issue #325 is the ticket you're working on):
```sh
git checkout -b 325-add-windows-support
```
#### 3. Did you find a bug?
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/probablynotablog/usb-canary/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/probablynotablog/usb-canary/issues/new).
Be sure to include a **title and clear description**, as much relevant information as possible - use the relevant bug report templates to create the issue.
### 4. Implement your fix or feature
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first.
### 5. Test your changes
We don't currently have an automated test suite, so it's up to you to test your bug fix or feature to ensure it does not impact existing features, unless that feature was really a bug and you're fixing it. If you're unable to test your new feature, reach out to one of the maintainers who will be happy to help. (It may take longer to be accepted)
### 6. Make a Pull Request
At this point, you should switch back to your master branch and make sure it's
up to date with USB Canary's master branch.
Push it!
Finally, go to GitHub and [make a Pull Request](https://help.github.com/articles/creating-a-pull-request).
================================================
FILE: ISSUE_TEMPLATE.md
================================================
<!--- Provide a general summary of the issue in the Title above -->
- [ ] Feature Request
- [ ] Bug Report
## Expected Behavior
<!--- If you're describing a bug, tell us what should happen -->
<!--- If you're suggesting a change/improvement, tell us how it should work -->
## Current Behavior
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- or ideas how to implement the addition or change -->
## Steps to Reproduce (for bugs)
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.
## Context
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* Version used:
* Operating System and version (e.g. Debian Jessie, Ubuntu Xenial Xerus):
================================================
FILE: LICENSE.txt
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
{one line to give the program's name and a brief idea of what it does.}
Copyright (C) {year} {name of author}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
{project} Copyright (C) {year} {fullname}
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
================================================
FILE: PULL_REQUEST_TEMPLATE.md
================================================
<!--- Provide a general summary of your changes in the Title above -->
- [ ] New Feature
- [ ] Bug Fix
## Description
<!--- Describe your changes in detail -->
## Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->
## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->
## Screenshots (if appropriate):
## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
================================================
FILE: README.md
================================================
# USB Canary
[](http://www.gnu.org/licenses/gpl-3.0)
[](https://travis-ci.org/errbufferoverfl/usb-canary)
USB Canary is a Linux and OSX tool that uses psutil to monitor USB devices
either around the clock, or just while your computer is locked. It can
be configured to send you an SMS via the Twilio API, notify a Slack
channel with it's inbuilt Slack bot, or send a push message through Pushover.
**Disclaimer**: Under no circumstances should USB Canary be used for production, production-like
systems or critical infrastructure.
## Getting Started
There are a couple of 3rd party libraries to get USB Canary running - so
Linux and OSX users should read the prerequisites for their distribution.
### Prerequisites
- [slackclient](https://github.com/slackapi/python-slackclient) - A
basic client for Slack.com, which can optionally connect to the Slack
Real Time Messaging (RTM) API.
- [twilio](https://github.com/twilio/twilio-python) - A Python module
for communicating with the Twilio API and generating TwiML.
- [pushover](https://github.com/Thibauth/python-pushover) - Comprehensive bindings and command line utility for the Pushover notification service
- [psutil](https://pypi.python.org/pypi/psutil) - Cross-platform lib
for process and system monitoring in Python.
- [gcc](https://gcc.gnu.org/) - GNU Compiler Collection
- [Xcode](https://developer.apple.com/xcode/) - Integrated development
environment for macOS
- [Quartz](https://pypi.python.org/pypi/pyobjc-framework-Quartz) -
Wrappers for the Quartz frameworks on macOS.
#### Installing Prerequisites on *Nix
Ubuntu and Debian users will need to make sure they have installed a C
compiler such as `gcc` as well as the `python-dev` package.
```
sudo apt-get install gcc python-dev python-pip
pip install psutil
```
Major Linux distros also provide binary distributions of psutil. However
this is not recommended as *Nix generall ship older versions.
```
sudo apt-get install python-psutil
```
You will also need to install the pip
[`apt` library](https://apt.alioth.debian.org/python-apt-doc/library/index.html)
through `apt` this can be done as follows:
```
sudo apt install python-apt
```
This library provides access to almost every functionality supported by
the underlying apt-pkg and apt-inst libraries. In Debian Jessie it may
come with the install but just double check to make sure it's there.
#### Installing Prerequisites on OSX
OSX users will need to install [Xcode](https://developer.apple.com/downloads/?name=Xcode) first then:
```
pip install psutil==5.3.1
```
OSX users will also need to manually install the [Quartz](https://pypi.python.org/pypi/pyobjc-framework-Quartz)
Python library as follows:
```
pip install pyobjc-framework-Quartz
```
Once distribution specific instractions have been followed the following
packages can all be installed via `pip`, in some cases you may need to
use `pip` with `sudo`. You can install the packages as follows:
```
pip install slackclient==1.0.9
pip install twilio==5.7.0
pip install python-pushover==0.3
pip install psutil==5.3.1
pip install sander-daemon==1.0.0
```
### Installing
Before running USB Canary, you will need to configure your `settings.json`
file, which should be located in the root directory. If it is not found
here, you will encounter an `IOError`.
An example `settings.json` file:
```json
{
"settings": {
"slack": {
"api_key": "xoxb-111111111111-abcdefghijklmnopqrstuvwx",
"channel_name": "usb_canary",
"botname": "USB Canary"
},
"twilio": {
"auth_token": "l7cy56u3Nys72vPNRS8TAbaW3X1Ap4ma",
"account_sid": "wP32p6qFNzJ25FD1IKM0YtX629eoHbrMiV",
"twilio_number": "+61491570156",
"mobile_number": "+61491570157"
},
"pushover": {
"priority": 1,
"user_key": "youruserkeygoeshere",
"api_token": "yourapitokengoeshere"
},
"general": {
"paranoid": true,
"screensaver": "xscreensaver",
"slack": false,
"twilio": true,
"pushover": false,
}
}
}
```
Note that `paranoid`, `slack` and `twilio` are boolean values and
should be set to `true` or `false`. If the file is formatted incorrectly
and it cannot be parsed, you will get a `ValueError`, you can use
[JSONLint](http://jsonlint.com/) if you find yourself having issues with
this.
# Linux
USB Canary, can 'detect' if you are running
`XScreenSaver` or `gnome-screensaver` on your computer, this is done by
just checking which packages are installed via the `apt` library, if
both of them are installed though, it will leave you to determine which
one you are using - if you have an unsupported screensaver, don't fret,
you can still run it in paranoid mode.
Paranoid mode is also suitable for people who want to monitor if their
servers have had USB's plugged into them,
although I haven't tested them on Linode, Amazon Web Services, or
Digital Ocean it is suitable for those with
physical servers that may need this sort of monitoring.
To start the application:
```shell
# Linux users
./usb_canary.py start | stop | restart
```
```shell
# OSX users
sudo ./usb_canary.py start | stop | restart
```
## Deployment
The following will outline the basic steps to deploying USB Canary to
Slack and Twilio.
### Twilio
To use the Twilio integration you will need to get an:
- [Auth Token](https://support.twilio.com/hc/en-us/articles/223136027-Auth-Tokens-and-how-to-change-them)
- [Account SID](https://support.twilio.com/hc/en-us/articles/223136607-What-is-an-Application-SID-)
- Twilio Mobile Number with SMS support
### Slack
To use the Slack integration you will need to [setup a bot user](https://api.slack.com/bot-users)
### Pushover
To use Pushover API for sending push messages to your devices, you need to create an [account and application](https://pushover.net/faq#overview-what)
## Exit Codes
| Exit Code | Reason | Solution |
|:-:|---|---|
| 0 | PASSED | |
| 400 | Unknown command. | Usage: `./usb_canary start | stop | restart` |
| 401 | Paranoid option not set. | Check that paranoid is set to `true` or `false` |
| 402 | Screensaver is not supported. | Currently known working screensavers include: XScreenSaver, gnome-screensaver |
| 403 | Screensaver conflict. | Screensaver detected, but both packages have been found. The user needs to be manually specified in the `settings.json` file |
| 404 | Slack credentials not provided. | Slack flag has been set, but credentials not provided, check `settings.json` |
| 405 | Slack credentials incorrect. | Slack flag has been set, but credentials are not correct, check `settings.json` |
| 406 | Twilio credentials not correct. | Twilio flag has been set, but credentials not provided, check `settings.json` |
| 407 | Twilio account SID not set | Twilio SID value has not been set, check `settings.json` |
| 408 | Twilio API token is blank | Twilio API token has not been set, check `settings.json` |
| 409 | Receiving mobile # is blank | Twilio receiving mobile number has not been set, check `settings.json` |
| 410 | Twilio mobile # is blank | Twilio allocated mobile number has not been set, check `settings.json` |
| 411 | Twilio key missing in settings.json | Twilio JSON block is not in settings file, check `settings.json` |
| 412 | Pushover user key missing in settings.json | Pushover user key (per account) is missing, check `settings.json` |
| 413 | Pushover user key missing in settings.json | Pushover api key (per registered app) is missing, check `settings.json` |
| 414 | Pushover priority level missing in settings.json | Pushover priority level is missing, check `settings.json` |
| 415 | Pushover key missing in settings.json | Pushover JSON block is not in settings file, check `settings.json` |
| 501 | `settings.json` file missing. | Download setting.json from Github |
| 502 | Unable to parse settings.json | Check for erroneous symbols, use [JSONLint](http://jsonlint.com/) to check formatting |
| 503 | Paranoid option not set correctly. | Paranoid option not set, or set incorrectly |
| 504 | Screensaver not found. | Screensaver not set, set incorrectly, or there was a problem detecting screensaver. |
| 505 | Verify that your operating system is supported. | Currently known working operating systems include: Debian Jessie, Debian Stretch, Ubuntu ZestyZapus |
| 506 | Screensaver or paranoid setting is not set correctly. | Check settings.json |
| 507 | Verbose logging option not set. | Check that verbose is set to `true` or `false` (without the quotes). True enables debugging, False enables info and higher |
## Built With
- [Python 3](https://www.python.org/download/releases/3.0/)
- [slackclient](https://github.com/slackapi/python-slackclient) - A basic client for Slack.com, which can optionally connect to the Slack Real Time Messaging (RTM) API.
- [twilio](https://github.com/twilio/twilio-python) - A Python module for communicating with the Twilio API and generating TwiML
- [psutil](https://pypi.python.org/pypi/psutil) - Cross-platform lib for process and system monitoring in Python.
- [Quartz](https://pypi.python.org/pypi/pyobjc-framework-Quartzhttps://pypi.python.org/pypi/pyobjc-framework-Quartz) - Wrappers for the Quartz frameworks on macOS
- [python-apt](https://apt.alioth.debian.org/python-apt-doc/library/index.html) - A library that provides access to almost every functionality supported by the underlying apt-pkg and apt-inst libraries
## Contributing
See the [CONTRIBUTING](CONTRIBUTING.md) file for details.
## Versioning
We use a simple major.minor.patch versioning where
- A major version change will make changes that are incompatible with previous versions
- A minor version change will add backwards-compatible functionality or bug-fixes
- A patch version change will add backwards-compatible bug-fixes
## Authors
- **errbufferoverfl** - *Initial work* - Security Tester by day, someone with too much time on their hands by night.
## License
This project is licensed under the GNU GPLv3 License - see the
[LICENSE](LICENSE.txt) file for details.
## Acknowledgements
- [timball](https://github.com/timball) - for recommending `sander-daemon`
- [cclauss](https://github.com/cclauss) - for integrating Travis CI
- [helpsterTee](https://github.com/helpsterTee) - for adding Pushover support
================================================
FILE: canary/__init__.py
================================================
================================================
FILE: canary/helpers.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
def diff(list1, list2):
c = set(list1).union(set(list2))
d = set(list1).intersection(set(list2))
return list(c - d)
================================================
FILE: canary/message_handler.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import logging
import sys
from twilio import TwilioRestException
from twilio.rest import TwilioRestClient
from canary import settings
from canary.slack import slack_bot
from canary.slack.slack import load_slack_settings
from canary.twilleo.twilleo import load_twilio_settings
from canary.pushovr.pushover import load_pushover_settings
from pushover import Client
def send_message(alert):
logging.debug('Opening settings.json.')
settings_file = settings.open_settings()
logging.debug('Getting Twilio settings.')
twilio_enabled = settings_file['settings']['general']['twilio']
logging.debug('Getting Slack settings.')
slack_enabled = settings_file['settings']['general']['slack']
logging.debug('Getting Pushover settings.')
pushover_enabled = settings_file['settings']['general']['pushover']
logging.debug('Checking if Twilio is enabled.')
if twilio_enabled:
logging.debug('Twilio enabled.')
logging.debug('Loading Twilio settings.')
twilio_settings = load_twilio_settings()
logging.debug('Configuring Twilio client.')
client = TwilioRestClient(twilio_settings["account_sid"], twilio_settings["auth_token"])
try:
logging.debug('Trying to send Twilio message.')
client.messages.create(body=alert,
to=twilio_settings['mobile_number'],
from_=twilio_settings["twilio_number"])
except TwilioRestException:
print('Unable to run application, correct Twilio credentials provided?')
logging.critical('Aborting... Unable to run application, Twilio credentials incorrect.')
sys.exit(406)
logging.debug('Checking if Slack is enabled.')
if slack_enabled:
logging.debug('Opening settings.json.')
slack_settings = load_slack_settings()
logging.debug('Staring up Slack Bot.')
slack_bot.run_bot(alert, slack_settings['channel_name'])
logging.debug('Checking if Pushover is enabled.')
if pushover_enabled:
logging.debug('Opening settings.json.')
pushover_settings = load_pushover_settings()
client = Client(pushover_settings['user_key'], api_token=pushover_settings['api_token'])
client.send_message(alert, priority=pushover_settings['priority'])
================================================
FILE: canary/operating_system/__init__.py
================================================
================================================
FILE: canary/operating_system/darwin.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import logging
import platform
import sys
import psutil
from canary.operating_system.helpers import check_state
preserved_state = None
if platform.system().lower() == 'darwin':
logging.debug('Importing the Quartz library.')
import Quartz
def monitor(paranoid, screensaver):
global preserved_state
preserved_state = psutil.disk_partitions()
logging.debug('Creating preserved state.')
logging.debug('Checking if paranoid.')
if paranoid is True:
logging.debug('Paranoid mode enabled.')
while True:
logging.debug('Checking state.')
preserved_state = check_state(preserved_state)
elif paranoid is False:
logging.debug('Paranoid mode disabled.')
logging.debug('Checking screensaver manager.')
osx_state = Quartz.CGSessionCopyCurrentDictionary()
logging.debug('Getting CGSessionCopyCurrentDictionary.')
screen_locked = osx_state.get("CGSSessionScreenIsLocked", 0)
logging.debug('Getting CGSSessionScreenIsLocked key.')
logging.debug('Screensaver status {}'.format(screen_locked))
while screen_locked is True:
logging.debug('Screen is locked.')
logging.debug('Checking state.')
preserved_state = check_state(preserved_state)
screen_locked = osx_state.get("CGSSessionScreenIsLocked", 0)
else:
print('Unable to run application, paranoid mode set correctly?')
logging.critical('Aborting... Unable to run application, paranoid mode not set correctly.')
sys.exit(401)
================================================
FILE: canary/operating_system/helpers.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import logging
import socket
import time
import psutil
from canary import helpers
from canary.message_handler import send_message
def check_state(preserved_state):
logging.debug('Getting current state of disk partitions.')
current_state = psutil.disk_partitions()
logging.debug('Comparing current state of disk partitions to the preserved state.')
if len(current_state) < len(preserved_state):
logging.debug('Found less disk partitions than in previous state. Checking difference.')
devices = helpers.diff(preserved_state, current_state)
logging.debug('Updating preserved state with current state.')
preserved_state = current_state
for device in devices:
alert = '{} - {} reported {} was removed.'.format(
time.strftime('%l:%M%p %Z on %b %d, %Y'), socket.gethostname(), device.mountpoint)
send_message(alert)
# logging.warning(alert)
elif len(current_state) > len(preserved_state):
logging.debug('Found more disk partitions than in previous state. Checking difference.')
devices = helpers.diff(preserved_state, current_state)
logging.debug('Updating preserved state with current state.')
preserved_state = current_state
for device in devices:
alert = '{} - {} reported {} was added.'.format(
time.strftime('%l:%M%p %Z on %b %d, %Y'), socket.gethostname(), device.mountpoint)
send_message(alert)
# logging.warning(alert)
return preserved_state
================================================
FILE: canary/operating_system/linux.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import logging
import os
import sys
import psutil
from canary.operating_system.helpers import check_state
from canary.screensaver import gnome_screensaver
preserved_state = None
def monitor(paranoid, screensaver):
preserved_state = psutil.disk_partitions()
logging.debug('Creating preserved state.')
logging.debug('Checking if paranoid.')
if paranoid:
logging.debug('Paranoid mode enabled.')
while True:
logging.debug('Checking state.')
preserved_state = check_state(preserved_state)
elif not paranoid:
logging.debug('Paranoid mode disabled.')
logging.debug('Checking screensaver manager.')
logging.debug('Screensaver set to: {}.'.format(screensaver.lower))
if screensaver.lower() == 'xscreensaver':
screensaver_monitor = os.popen('xscreensaver-command -watch')
logging.debug('Opening xscreensaver-command -watch.')
logging.debug('Reading xscreensaver-command -watch.')
line = screensaver_monitor.readline()
logging.debug('{}'.format(line))
while line.startswith('LOCK'):
logging.debug('Screen is locked.')
logging.debug('Checking state.')
preserved_state = check_state(preserved_state)
elif screensaver.lower() == 'gnome-screensaver':
if gnome_screensaver.is_active():
preserved_state = check_state(preserved_state)
else:
print('Unable to run application, paranoid mode set correctly?')
logging.critical('Aborting... Unable to run application, paranoid mode not set correctly.')
sys.exit(401)
================================================
FILE: canary/pushovr/__init__.py
================================================
================================================
FILE: canary/pushovr/pushover.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import sys
import canary.settings
def load_pushover_settings():
"""
Opens settings.json and checks all values have been set, if they have, creates a list containing these details.
If not exits and notifies user of misconfiguration
:return: list containing options to use Pushover API
"""
pushover_settings = canary.settings.open_settings()
pushover = pushover_settings['settings']['pushover']
try:
# sanity check that the user has actually supplied data
if not pushover['user_key']:
print('Pushover user key has been left blank')
sys.exit(412)
elif not pushover['api_token']:
print('Pushover API token has been left blank')
sys.exit(413)
elif not pushover['priority']:
print('Pushover message priority has been left blank')
sys.exit(414)
else:
return pushover
except KeyError:
print('Pushover key missing in the settings file')
sys.exit(415)
================================================
FILE: canary/screensaver/__init__.py
================================================
================================================
FILE: canary/screensaver/gnome_screensaver.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import logging
import os
def is_active():
logging.debug('Opening gnome-screensaver-command -q.')
logging.debug('gnome-screensaver-command -q.')
screensaver_monitor = os.popen('gnome-screensaver-command -q')
line = screensaver_monitor.readline()
logging.debug('{}'.format(line))
logging.debug('Checking if screensaver is currently active.')
if 'is active' in line:
logging.debug('Screensaver is active.')
return True
================================================
FILE: canary/screensaver/helpers.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import logging
import platform
import sys
import canary.settings
if platform.system().lower == 'linux':
logging.debug('Importing the apt library.')
import apt
supported_screensavers = ['gnome-screensaver', 'xscreensaver']
def set_screensaver(screensaver_option):
"""
Detects the screensaver - this can be specified by the user at install time, or detected if not set.
If screensaver is specified, it is checked against the supported screensavers list.
:param screensaver_option: the screensaver returned by the command line.
:return: the identified screensaver as specified by the user, or detected by the program
"""
logging.debug('Checking screensaver manager.')
if screensaver_option == "":
logging.debug('No screensaver specified, attempting auto-detection.')
screensaver_option = identify_screensaver()
logging.debug('Saving detected screensaver.')
save_screensaver(screensaver_option)
else:
logging.debug('Screensaver specified, checking if supported.')
if screensaver_option in supported_screensavers:
logging.debug('Saving supported screensaver.')
save_screensaver(screensaver_option)
else:
print('Unable to run application, screensaver supported?')
logging.critical('Aborting... Unable to run application, screensaver not supported.')
sys.exit(402)
return screensaver_option
def save_screensaver(screensaver):
"""
Writes the screensaver to the settings.json file
:param screensaver: the screensaver
:return:
"""
logging.debug('Opening settings.json.')
settings = canary.settings.open_settings()
logging.debug('Checking if screensaver option has been specified.')
if settings['settings']['general']['screensaver']:
logging.debug('Screensaver specified.')
logging.debug('Writing over screensaver value {}'.format(settings['settings']['general']['screensaver']))
settings['settings']['general']['screensaver'] = screensaver
logging.debug('Saving settings.json.')
canary.settings.save_settings(settings)
else:
logging.debug('Screensaver not specified.')
settings['settings']['general']['screensaver'] = screensaver
logging.debug('Saving settings.json.')
canary.settings.save_settings(settings)
def identify_screensaver():
cache = apt.Cache()
logging.debug('Getting apt cache.')
logging.debug('Checking if supported screensaver packages are installed.')
if cache['xscreensaver'].is_installed and cache['gnome-screensaver'].is_installed:
logging.debug('xscreensaver and gnome-screensaver installed. User must specify which package to monitor.')
print("XScreenSaver and gnome-screensaver detected. Please select active screensaver in the settings file "
"before proceeding.")
sys.exit(403)
if cache['xscreensaver'].is_installed:
logging.debug('\txscreensaver installed.')
return 'xscreensaver'
elif cache['gnome-screensaver'].is_installed:
logging.debug('\tgnome-screensaver installed.')
return 'gnome-screensaver'
else:
print('Unable to run application, screensaver supported?')
logging.critical('Aborting... Unable to run application, screensaver not supported.')
sys.exit(402)
def get_supported_screensavers():
return supported_screensavers
================================================
FILE: canary/screensaver/xscreensaver.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
"""
xscreensaver management helper function should go here
"""
================================================
FILE: canary/settings.py
================================================
# coding=utf-8
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import json
import logging
import os
import sys
supported_operating_systems = ['linux', 'darwin']
settings_file_path = os.path.dirname(__file__) + '/../settings.json'
def save_settings(options):
logging.debug('Saving settings to {}'.format(os.path.abspath(settings_file_path)))
json.dump(options, open(settings_file_path, 'w'))
def open_settings():
logging.debug('Attempting to open settings.json as read-only')
try:
with open(settings_file_path, 'r') as settings_file:
settings = json.load(settings_file)
return settings
except IOError:
print('File {} not found'.format(settings_file_path))
logging.critical('Aborting... File {} not found.'.format(os.path.abspath(settings_file_path)))
sys.exit(501)
except ValueError:
print('No JSON object could be decoded')
logging.critical('Aborting... No JSON object could be decoded')
sys.exit(502)
def check_paranoid_setting(paranoid_option):
paranoid_set_true = paranoid_option is True
paranoid_set_false = paranoid_option is False
logging.debug('Checking if paranoid option has been set correctly.')
if paranoid_set_true or paranoid_set_false:
return True
else:
print('Aborting... Paranoid option has not set to "True" or "False"')
logging.critical('{} is not a valid selection. Please set to "True" or "False".')
sys.exit(503)
def check_screensaver_setting(screensaver_option):
logging.debug('Checking if screensaver option has been set.')
if screensaver_option:
return True
else:
print('Aborting... Screensaver option has not been set.')
logging.critical('Screensaver option has not been set.')
sys.exit(504)
def check_logging_verbosity(verbose_option):
if verbose_option is True:
return True
elif verbose_option is False:
return False
else:
print('Aborting... Verbose option has not been set.')
logging.critical('Verbose option has not been set.')
sys.exit(507)
def get_supported_operating_systems():
return supported_operating_systems
================================================
FILE: canary/slack/__init__.py
================================================
================================================
FILE: canary/slack/slack.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import logging
import sys
import canary.settings
import canary.slack.slack_bot
def load_slack_settings():
"""
Opens settings.json and checks all values have been set, if they have,
creates a list containing these details and sets up Slack bot.
If not exits and notifies user of misconfiguration
:return: list containing options to use Slack API
"""
logging.debug('Opening settings.json.')
slack_settings = canary.settings.open_settings()
logging.debug('Getting Slack settings.')
slack = slack_settings['settings']['slack']
# sanity check that the user has actually supplied data
api_key = not slack["api_key"]
botname = not slack["botname"]
channel_name = not slack["channel_name"]
logging.debug('Checking Slack Botname has been supplied.')
logging.debug('Checking Slack API key has been supplied.')
logging.debug('Checking Slack Channel Name has been supplied.')
if botname and api_key and channel_name:
print('Unable to run application, Slack credentials provided?')
logging.critical('Aborting... Unable to run application, Slack credentials not supplied.')
sys.exit(404)
logging.debug('Slack credentials supplied. Starting Slack bot.')
canary.slack.slack_bot.setup(slack, channel_name)
return slack
================================================
FILE: canary/slack/slack_bot.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import logging
import sys
import slackclient
slack_client = ''
channel_name = ''
def setup(slack, channel):
logging.debug('Setting up Slack Bot.')
global slack_client
slack_client = slackclient.SlackClient(slack['api_key'])
logging.debug('\tSetting Slack API key.')
logging.debug('\tSetting Slack channel name.')
global channel_name
channel_name = channel
def run_bot(message, channel):
if slack_client.rtm_connect():
logging.debug('Getting list of channels.')
channel_list = slack_client.api_call('channels.list')['channels']
channel_exists = False
logging.debug('Checking existence of {} channel.'.format(channel_name))
for dic in channel_list:
if dic.get('name') == channel:
logging.debug('\tSlack channel exists.')
channel_exists = True
break
if channel_exists:
logging.debug('\tPosting message to Slack.')
slack_client.api_call("chat.postMessage", channel=channel, text=message, as_user=True)
else:
logging.info('\tChannel not found in Slack directory - posting to #general instead.')
message = "Hi! :wave: It looks like some of my settings might be a little frazzled, and I can't post " \
"messages like normal."
slack_client.api_call("chat.postMessage", channel='general', text=message, as_user=True)
else:
print('Aborting... Failed to connect to Slack. Invalid Slack token or bot ID?')
logging.critical('Failed to connect to Slack. Invalid Slack API key or Bot ID.')
sys.exit(405)
================================================
FILE: canary/twilleo/__init__.py
================================================
================================================
FILE: canary/twilleo/twilleo.py
================================================
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import sys
import canary.settings
def load_twilio_settings():
"""
Opens settings.json and checks all values have been set, if they have, creates a list containing these details.
If not exits and notifies user of misconfiguration
:return: list containing options to use Twilio API
"""
twilio_settings = canary.settings.open_settings()
twilio = twilio_settings['settings']['twilio']
try:
# sanity check that the user has actually supplied data
if not twilio['account_sid']:
print('Twilio Account SID has been left blank')
sys.exit(407)
elif not twilio['auth_token']:
print('Twilio API token has been left blank')
sys.exit(408)
elif not twilio['mobile_number']:
print('Receiving mobile number has been left blank')
sys.exit(409)
elif not twilio['twilio_number']:
print('Twilio mobile number has been left blank')
sys.exit(410)
else:
return twilio
except KeyError:
print('Twilio key missing in the settings file')
sys.exit(411)
================================================
FILE: requirements.txt
================================================
psutil==5.3.1
sander-daemon==1.0.0
slackclient==1.0.9
twilio==5.7.0
python-pushover==0.3
================================================
FILE: settings.json
================================================
{
"settings": {
"slack": {
"api_key": "xoxb-111111111111-abcdefghijklmnopqrstuvwx",
"channel_name": "usb_canary",
"botname": "USB Canary"
},
"twilio": {
"auth_token": "l7cy56u3Nys72vPNRS8TAbaW3X1Ap4ma",
"account_sid": "wP32p6qFNzJ25FD1IKM0YtX629eoHbrMiV",
"twilio_number": "+61491570156",
"mobile_number": "+61491570157"
},
"pushover": {
"priority": 1,
"user_key": "youruserkeygoeshere",
"api_token": "yourapitokengoeshere"
},
"general": {
"paranoid": true,
"screensaver": "xscreensaver",
"slack": false,
"twilio": true,
"pushover": false
}
}
}
================================================
FILE: usbcanary.py
================================================
#!/usr/bin/env python
# coding=utf-8
# usb_canary - a Linux tool that uses pyudev to monitor devices while
# your computer is locked. In the case it detects someone plugging in
# or unplugging devices it can be configured to make a noise or send
# you an SMS alerting to you of the potential security breach.
# Copyright (C) 2017 errbufferoverfl
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
import os
import platform
import sys
from daemon import Daemon
from canary import settings
from canary.operating_system import darwin
from canary.operating_system import linux
from canary.screensaver import helpers
twilio_settings = None
slack_settings = None
pushover_settings = None
file_path = os.path.dirname(__file__)
class UsbCanary(Daemon):
def run(self):
while True:
self.main()
def main(self):
options = settings.open_settings()['settings']['general']
if settings.check_paranoid_setting(options['paranoid']) is True:
paranoid_enabled = True
else:
paranoid_enabled = False
screensaver_enabled = helpers.set_screensaver(options['screensaver'])
try:
while True:
self.run_canary(paranoid_enabled, screensaver_enabled)
except AttributeError:
print('Unable to start application, mode or screensaver has not been set properly')
sys.exit(506)
def run_canary(self, paranoid_enabled, screensaver_enabled):
operating_system = platform.system().lower()
if operating_system in settings.get_supported_operating_systems():
if operating_system == 'linux':
linux.monitor(paranoid_enabled, screensaver_enabled)
elif operating_system == 'darwin':
darwin.monitor(paranoid_enabled, screensaver_enabled)
else:
print('{} is unsupported at this time. Aborting...'.format(operating_system))
sys.exit(505)
if __name__ == '__main__':
daemon = UsbCanary('/tmp/usbcanary.pid')
if len(sys.argv) == 2:
if 'start' == sys.argv[1]:
daemon.start()
elif 'stop' == sys.argv[1]:
daemon.stop()
elif 'restart' == sys.argv[1]:
daemon.restart()
else:
print('Unknown command {}'.format(sys.argv[1]))
print('usage: {} start|stop|restart'.format(sys.argv[0]))
sys.exit(400)
sys.exit(0)
else:
print('usage: {} start|stop|restart'.format(sys.argv[0]))
sys.exit(400)
gitextract_9p5qbzdt/ ├── .gitignore ├── .travis.yml ├── CONTRIBUTING.md ├── ISSUE_TEMPLATE.md ├── LICENSE.txt ├── PULL_REQUEST_TEMPLATE.md ├── README.md ├── canary/ │ ├── __init__.py │ ├── helpers.py │ ├── message_handler.py │ ├── operating_system/ │ │ ├── __init__.py │ │ ├── darwin.py │ │ ├── helpers.py │ │ └── linux.py │ ├── pushovr/ │ │ ├── __init__.py │ │ └── pushover.py │ ├── screensaver/ │ │ ├── __init__.py │ │ ├── gnome_screensaver.py │ │ ├── helpers.py │ │ └── xscreensaver.py │ ├── settings.py │ ├── slack/ │ │ ├── __init__.py │ │ ├── slack.py │ │ └── slack_bot.py │ └── twilleo/ │ ├── __init__.py │ └── twilleo.py ├── requirements.txt ├── settings.json └── usbcanary.py
SYMBOL INDEX (25 symbols across 13 files)
FILE: canary/helpers.py
function diff (line 18) | def diff(list1, list2):
FILE: canary/message_handler.py
function send_message (line 32) | def send_message(alert):
FILE: canary/operating_system/darwin.py
function monitor (line 32) | def monitor(paranoid, screensaver):
FILE: canary/operating_system/helpers.py
function check_state (line 27) | def check_state(preserved_state):
FILE: canary/operating_system/linux.py
function monitor (line 29) | def monitor(paranoid, screensaver):
FILE: canary/pushovr/pushover.py
function load_pushover_settings (line 21) | def load_pushover_settings():
FILE: canary/screensaver/gnome_screensaver.py
function is_active (line 21) | def is_active():
FILE: canary/screensaver/helpers.py
function set_screensaver (line 30) | def set_screensaver(screensaver_option):
function save_screensaver (line 55) | def save_screensaver(screensaver):
function identify_screensaver (line 77) | def identify_screensaver():
function get_supported_screensavers (line 99) | def get_supported_screensavers():
FILE: canary/settings.py
function save_settings (line 28) | def save_settings(options):
function open_settings (line 33) | def open_settings():
function check_paranoid_setting (line 49) | def check_paranoid_setting(paranoid_option):
function check_screensaver_setting (line 62) | def check_screensaver_setting(screensaver_option):
function check_logging_verbosity (line 72) | def check_logging_verbosity(verbose_option):
function get_supported_operating_systems (line 83) | def get_supported_operating_systems():
FILE: canary/slack/slack.py
function load_slack_settings (line 23) | def load_slack_settings():
FILE: canary/slack/slack_bot.py
function setup (line 25) | def setup(slack, channel):
function run_bot (line 35) | def run_bot(message, channel):
FILE: canary/twilleo/twilleo.py
function load_twilio_settings (line 21) | def load_twilio_settings():
FILE: usbcanary.py
class UsbCanary (line 37) | class UsbCanary(Daemon):
method run (line 38) | def run(self):
method main (line 42) | def main(self):
method run_canary (line 59) | def run_canary(self, paranoid_enabled, screensaver_enabled):
Condensed preview — 29 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (87K chars).
[
{
"path": ".gitignore",
"chars": 46,
"preview": "# IntelliJ project files\n.idea\n.DS_Store\n*.pyc"
},
{
"path": ".travis.yml",
"chars": 424,
"preview": "sudo: false\ndist: trusty\nlanguage: python\ncache: pip\npython:\n - \"2.7.13\"\n - \"3.6\"\ninstall:\n - pip install --upg"
},
{
"path": "CONTRIBUTING.md",
"chars": 1990,
"preview": "# Contributing\n\nFirst off, thank you for considering contributing to USB Canary. \n\n### 1. Where do I go from here?\n\nIf y"
},
{
"path": "ISSUE_TEMPLATE.md",
"chars": 1202,
"preview": "<!--- Provide a general summary of the issue in the Title above -->\n- [ ] Feature Request\n- [ ] Bug Report \n\n## Expected"
},
{
"path": "LICENSE.txt",
"chars": 35140,
"preview": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free "
},
{
"path": "PULL_REQUEST_TEMPLATE.md",
"chars": 1525,
"preview": "<!--- Provide a general summary of your changes in the Title above -->\n- [ ] New Feature\n- [ ] Bug Fix \n\n## Description\n"
},
{
"path": "README.md",
"chars": 10428,
"preview": "# USB Canary\n[](http://www.gnu.org/licenses/gp"
},
{
"path": "canary/__init__.py",
"chars": 0,
"preview": ""
},
{
"path": "canary/helpers.py",
"chars": 931,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "canary/message_handler.py",
"chars": 3141,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "canary/operating_system/__init__.py",
"chars": 0,
"preview": ""
},
{
"path": "canary/operating_system/darwin.py",
"chars": 2378,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "canary/operating_system/helpers.py",
"chars": 2353,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "canary/operating_system/linux.py",
"chars": 2495,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "canary/pushovr/__init__.py",
"chars": 0,
"preview": ""
},
{
"path": "canary/pushovr/pushover.py",
"chars": 1826,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "canary/screensaver/__init__.py",
"chars": 0,
"preview": ""
},
{
"path": "canary/screensaver/gnome_screensaver.py",
"chars": 1265,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "canary/screensaver/helpers.py",
"chars": 4262,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "canary/screensaver/xscreensaver.py",
"chars": 865,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "canary/settings.py",
"chars": 2970,
"preview": "# coding=utf-8\n\n# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the "
},
{
"path": "canary/slack/__init__.py",
"chars": 0,
"preview": ""
},
{
"path": "canary/slack/slack.py",
"chars": 2120,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "canary/slack/slack_bot.py",
"chars": 2456,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "canary/twilleo/__init__.py",
"chars": 0,
"preview": ""
},
{
"path": "canary/twilleo/twilleo.py",
"chars": 1940,
"preview": "# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your computer is locked. In the case it detects "
},
{
"path": "requirements.txt",
"chars": 89,
"preview": "psutil==5.3.1\nsander-daemon==1.0.0\nslackclient==1.0.9\ntwilio==5.7.0\npython-pushover==0.3\n"
},
{
"path": "settings.json",
"chars": 671,
"preview": "{\n \"settings\": {\n \"slack\": {\n \"api_key\": \"xoxb-111111111111-abcdefghijklmnopqrstuvwx\",\n \"channel_name\": \"u"
},
{
"path": "usbcanary.py",
"chars": 2981,
"preview": "#!/usr/bin/env python\n# coding=utf-8\n\n# usb_canary - a Linux tool that uses pyudev to monitor devices while\n# your compu"
}
]
About this extraction
This page contains the full source code of the errbufferoverfl/usb-canary GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 29 files (81.5 KB), approximately 19.2k tokens, and a symbol index with 25 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.