🎉 Beginning
First push for beginning of project
This commit is contained in:
commit
07c61c1b1c
674
LICENSE
Normal file
674
LICENSE
Normal file
@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://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 <https://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:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
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
|
||||
<https://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
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
136
README.md
Normal file
136
README.md
Normal file
@ -0,0 +1,136 @@
|
||||
# Shogo
|
||||
[![IRC](https://img.shields.io/badge/ircd.chat-%23tcpdirect-blue.svg)](ircs://ircd.chat:6697/#tcpdirect) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
|
||||
|
||||
Shogo is a Shodan CLI made in Go
|
||||
|
||||
### 🎯 Features:
|
||||
+ Prettier printing
|
||||
+ Faster JSON parsing
|
||||
+ Faster HTTP requests
|
||||
+ Multiple command arguments
|
||||
|
||||
## 📋 Requirements
|
||||
|
||||
```
|
||||
go (1.20+)
|
||||
```
|
||||
|
||||
## ⚙️ Installation
|
||||
```
|
||||
git clone https://git.tcp.direct/perp/shogo
|
||||
cd shogo/cmd/shogo
|
||||
go install .
|
||||
```
|
||||
|
||||
## ❓ Commands
|
||||
| Todo | Working | Broken |
|
||||
| -------- | ------- | ------ |
|
||||
| convert | count | domain |
|
||||
| data | host | search |
|
||||
| download | info | |
|
||||
| init | myip | |
|
||||
| org | alert | |
|
||||
| radar | version | |
|
||||
| scan | | |
|
||||
| stats | | |
|
||||
| stream | | |
|
||||
|
||||
## ⚡️ Usage
|
||||
```
|
||||
Shodan CLI made in Go
|
||||
|
||||
Usage:
|
||||
shogo [flags]
|
||||
shogo [command]
|
||||
|
||||
Available Commands:
|
||||
count Return number of results for a search
|
||||
domain Return domain information
|
||||
host Return host information
|
||||
info Return your account information
|
||||
myip Return your IP address
|
||||
search Return a search result
|
||||
version Return shogo version
|
||||
alert Manage your network alerts
|
||||
help Help about any command
|
||||
|
||||
Flags:
|
||||
--no-color Disable color output
|
||||
-h, --help help for shogo
|
||||
|
||||
Use "shogo [command] --help" for more information about a command.
|
||||
|
||||
```
|
||||
```
|
||||
Return number of results for a search
|
||||
|
||||
Usage:
|
||||
shogo count [flags]
|
||||
|
||||
Flags:
|
||||
-h, --help help for count
|
||||
|
||||
Global Flags:
|
||||
--no-color Disable color output
|
||||
```
|
||||
```
|
||||
Return your account information
|
||||
|
||||
Usage:
|
||||
shogo info [flags]
|
||||
|
||||
Aliases:
|
||||
info, information
|
||||
|
||||
Flags:
|
||||
-a, --api Show API information
|
||||
-p, --profile Show profile information
|
||||
-h, --help help for info
|
||||
|
||||
Global Flags:
|
||||
--no-color Disable color output
|
||||
```
|
||||
```
|
||||
Manage your network alerts
|
||||
|
||||
Usage:
|
||||
shogo alert [flags]
|
||||
shogo alert [command]
|
||||
|
||||
Available Commands:
|
||||
clear Clear all alerts
|
||||
create Create an alert
|
||||
delete Delete an alert
|
||||
info Return alert information
|
||||
list Return all the active alerts
|
||||
|
||||
Flags:
|
||||
--no-color Disable color output
|
||||
-h, --help help for alert
|
||||
|
||||
Use "shogo alert [command] --help" for more information about a command.
|
||||
```
|
||||
|
||||
### Get key information
|
||||
```
|
||||
shogo info -a -p
|
||||
```
|
||||
|
||||
### Get query count
|
||||
```
|
||||
shogo count "apache" "nginx"
|
||||
```
|
||||
|
||||
### Get alert list
|
||||
```
|
||||
shogo alert list
|
||||
```
|
||||
|
||||
### Show alert information
|
||||
```
|
||||
shogo alert show <alert-id>
|
||||
```
|
||||
|
||||
## ⚠️ License
|
||||
##### Shogo is provided under the [GNU General Public License v3.0](./LICENSE)
|
||||
###### Developers are not responsible for any misuse
|
40
cmd/shogo/commands/alert/alert.go
Normal file
40
cmd/shogo/commands/alert/alert.go
Normal file
@ -0,0 +1,40 @@
|
||||
package alert
|
||||
|
||||
import (
|
||||
"os"
|
||||
|
||||
"github.com/fatih/color"
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Global flags
|
||||
var noColor bool
|
||||
|
||||
// Alert command
|
||||
var AlertCmd = &cobra.Command{
|
||||
Use: "alert",
|
||||
Short: "Manage your network alerts",
|
||||
Run: func(cmd *cobra.Command, _ []string) {
|
||||
utils.CheckColor()
|
||||
if err := cmd.Help(); err != nil {
|
||||
color.Red("Error: %s", err.Error())
|
||||
os.Exit(1)
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
// Add flags
|
||||
AlertCmd.PersistentFlags().BoolVar(&utils.Disabled, "no-color", false, "Disable color output")
|
||||
AlertCmd.Flags().SortFlags = false
|
||||
cobra.EnableCommandSorting = false
|
||||
|
||||
// Add commands
|
||||
AlertCmd.AddCommand(clearCmd)
|
||||
AlertCmd.AddCommand(createCmd)
|
||||
AlertCmd.AddCommand(deleteCmd)
|
||||
AlertCmd.AddCommand(infoCmd)
|
||||
AlertCmd.AddCommand(listCmd)
|
||||
}
|
18
cmd/shogo/commands/alert/clear.go
Normal file
18
cmd/shogo/commands/alert/clear.go
Normal file
@ -0,0 +1,18 @@
|
||||
package alert
|
||||
|
||||
import (
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/shodan/alert"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Clear command
|
||||
var clearCmd = &cobra.Command{
|
||||
Use: "clear",
|
||||
Short: "Clear all alerts",
|
||||
Run: func(_ *cobra.Command, _ []string) {
|
||||
utils.CheckColor()
|
||||
alert.Clear()
|
||||
},
|
||||
}
|
19
cmd/shogo/commands/alert/create.go
Normal file
19
cmd/shogo/commands/alert/create.go
Normal file
@ -0,0 +1,19 @@
|
||||
package alert
|
||||
|
||||
import (
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/shodan/alert"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Create command
|
||||
var createCmd = &cobra.Command{
|
||||
Use: "create",
|
||||
Short: "Create an alert",
|
||||
Args: cobra.MinimumNArgs(2),
|
||||
Run: func(_ *cobra.Command, args []string) {
|
||||
utils.CheckColor()
|
||||
alert.Create(args[0], args[1])
|
||||
},
|
||||
}
|
30
cmd/shogo/commands/alert/delete.go
Normal file
30
cmd/shogo/commands/alert/delete.go
Normal file
@ -0,0 +1,30 @@
|
||||
package alert
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/shodan/alert"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Delete command
|
||||
var deleteCmd = &cobra.Command{
|
||||
Use: "delete",
|
||||
Short: "Delete an alert",
|
||||
Args: cobra.MinimumNArgs(1),
|
||||
Run: func(_ *cobra.Command, args []string) {
|
||||
utils.CheckColor()
|
||||
|
||||
// Loop through args
|
||||
if len(args) > 1 {
|
||||
for index := range args {
|
||||
alert.Delete(args[index])
|
||||
fmt.Println("")
|
||||
}
|
||||
} else {
|
||||
alert.Delete(args[0])
|
||||
}
|
||||
},
|
||||
}
|
30
cmd/shogo/commands/alert/info.go
Normal file
30
cmd/shogo/commands/alert/info.go
Normal file
@ -0,0 +1,30 @@
|
||||
package alert
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/shodan/alert"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Info command
|
||||
var infoCmd = &cobra.Command{
|
||||
Use: "info",
|
||||
Short: "Return alert information",
|
||||
Args: cobra.MinimumNArgs(1),
|
||||
Run: func(_ *cobra.Command, args []string) {
|
||||
utils.CheckColor()
|
||||
|
||||
// Loop through args
|
||||
if len(args) > 1 {
|
||||
for index := range args {
|
||||
alert.Info(args[index])
|
||||
fmt.Println("")
|
||||
}
|
||||
} else {
|
||||
alert.Info(args[0])
|
||||
}
|
||||
},
|
||||
}
|
18
cmd/shogo/commands/alert/list.go
Normal file
18
cmd/shogo/commands/alert/list.go
Normal file
@ -0,0 +1,18 @@
|
||||
package alert
|
||||
|
||||
import (
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/shodan/alert"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// List command
|
||||
var listCmd = &cobra.Command{
|
||||
Use: "list",
|
||||
Short: "Return all the active alerts",
|
||||
Run: func(_ *cobra.Command, _ []string) {
|
||||
utils.CheckColor()
|
||||
alert.List()
|
||||
},
|
||||
}
|
33
cmd/shogo/commands/count.go
Normal file
33
cmd/shogo/commands/count.go
Normal file
@ -0,0 +1,33 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/shodan"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Count command
|
||||
var countCmd = &cobra.Command{
|
||||
Use: "count",
|
||||
Short: "Return number of results for a search",
|
||||
Args: cobra.MinimumNArgs(1),
|
||||
Run: func(_ *cobra.Command, args []string) {
|
||||
utils.CheckColor()
|
||||
|
||||
// Loop through args
|
||||
if len(args) > 1 {
|
||||
for index := range args {
|
||||
shodan.Count(args[index])
|
||||
// Print newline per argument
|
||||
if index != len(args)-1 {
|
||||
fmt.Println("")
|
||||
}
|
||||
}
|
||||
} else {
|
||||
shodan.Count(args[0])
|
||||
}
|
||||
},
|
||||
}
|
33
cmd/shogo/commands/domain.go
Normal file
33
cmd/shogo/commands/domain.go
Normal file
@ -0,0 +1,33 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/shodan"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Domain command
|
||||
var domainCmd = &cobra.Command{
|
||||
Use: "domain",
|
||||
Short: "Return domain information",
|
||||
Args: cobra.MinimumNArgs(1),
|
||||
Run: func(_ *cobra.Command, args []string) {
|
||||
utils.CheckColor()
|
||||
|
||||
// Loop through args
|
||||
if len(args) > 1 {
|
||||
for index := range args {
|
||||
shodan.Domain(args[index])
|
||||
// Print newline per argument
|
||||
if index != len(args)-1 {
|
||||
fmt.Println("")
|
||||
}
|
||||
}
|
||||
} else {
|
||||
shodan.Domain(args[0])
|
||||
}
|
||||
},
|
||||
}
|
33
cmd/shogo/commands/host.go
Normal file
33
cmd/shogo/commands/host.go
Normal file
@ -0,0 +1,33 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/shodan"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Host command
|
||||
var hostCmd = &cobra.Command{
|
||||
Use: "host",
|
||||
Short: "Return host information",
|
||||
Args: cobra.MinimumNArgs(1),
|
||||
Run: func(_ *cobra.Command, args []string) {
|
||||
utils.CheckColor()
|
||||
|
||||
// Loop through args
|
||||
if len(args) > 1 {
|
||||
for index := range args {
|
||||
shodan.Host(args[index])
|
||||
// Print newline per argument
|
||||
if index != len(args)-1 {
|
||||
fmt.Println("")
|
||||
}
|
||||
}
|
||||
} else {
|
||||
shodan.Host(args[0])
|
||||
}
|
||||
},
|
||||
}
|
32
cmd/shogo/commands/info.go
Normal file
32
cmd/shogo/commands/info.go
Normal file
@ -0,0 +1,32 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/shodan"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Access flags
|
||||
var (
|
||||
api bool
|
||||
profile bool
|
||||
)
|
||||
|
||||
// Information command
|
||||
var infoCmd = &cobra.Command{
|
||||
Use: "info",
|
||||
Short: "Return your account information",
|
||||
Aliases: []string{"information"},
|
||||
Run: func(_ *cobra.Command, _ []string) {
|
||||
utils.CheckColor()
|
||||
shodan.Info(api, profile)
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
// Add flags
|
||||
infoCmd.PersistentFlags().BoolVarP(&api, "api", "a", false, "Show API information")
|
||||
infoCmd.PersistentFlags().BoolVarP(&profile, "profile", "p", false, "Show profile information")
|
||||
infoCmd.Flags().SortFlags = false
|
||||
}
|
18
cmd/shogo/commands/myip.go
Normal file
18
cmd/shogo/commands/myip.go
Normal file
@ -0,0 +1,18 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/shodan"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// MyIP command
|
||||
var myIPCmd = &cobra.Command{
|
||||
Use: "myip",
|
||||
Short: "Return your IP address",
|
||||
Run: func(_ *cobra.Command, _ []string) {
|
||||
utils.CheckColor()
|
||||
shodan.MyIp()
|
||||
},
|
||||
}
|
52
cmd/shogo/commands/root.go
Normal file
52
cmd/shogo/commands/root.go
Normal file
@ -0,0 +1,52 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"os"
|
||||
|
||||
"github.com/fatih/color"
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/cmd/shogo/commands/alert"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Root command
|
||||
var rootCmd = &cobra.Command{
|
||||
Use: "shogo",
|
||||
Short: "Shodan CLI made in Go",
|
||||
Run: func(cmd *cobra.Command, _ []string) {
|
||||
utils.CheckColor()
|
||||
if err := cmd.Help(); err != nil {
|
||||
color.Red("Error: %s", err.Error())
|
||||
os.Exit(1)
|
||||
}
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
// Add flags
|
||||
rootCmd.PersistentFlags().BoolVar(&utils.Disabled, "no-color", false, "Disable color output")
|
||||
rootCmd.CompletionOptions.DisableDefaultCmd = true
|
||||
rootCmd.Flags().SortFlags = false
|
||||
cobra.EnableCommandSorting = false
|
||||
|
||||
// Add commands
|
||||
rootCmd.AddCommand(countCmd)
|
||||
rootCmd.AddCommand(domainCmd)
|
||||
rootCmd.AddCommand(hostCmd)
|
||||
rootCmd.AddCommand(infoCmd)
|
||||
rootCmd.AddCommand(myIPCmd)
|
||||
rootCmd.AddCommand(searchCmd)
|
||||
rootCmd.AddCommand(versionCmd)
|
||||
|
||||
// Add subcommands
|
||||
rootCmd.AddCommand(alert.AlertCmd)
|
||||
}
|
||||
|
||||
// Execute command
|
||||
func Execute() {
|
||||
if err := rootCmd.Execute(); err != nil {
|
||||
color.Red("Error: %s", err.Error())
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
80
cmd/shogo/commands/search.go
Normal file
80
cmd/shogo/commands/search.go
Normal file
@ -0,0 +1,80 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"github.com/panjf2000/ants/v2"
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/shodan"
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Access flags
|
||||
var (
|
||||
pages int
|
||||
fields []string
|
||||
separator string
|
||||
threads int
|
||||
)
|
||||
|
||||
// Search command
|
||||
var searchCmd = &cobra.Command{
|
||||
Use: "search",
|
||||
Short: "Return a search result",
|
||||
Args: cobra.MinimumNArgs(1),
|
||||
Run: func(_ *cobra.Command, args []string) {
|
||||
utils.CheckColor()
|
||||
|
||||
// Results channel
|
||||
results := make(chan string)
|
||||
|
||||
// Goroutine pool
|
||||
pool, err := ants.NewPool(threads)
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
os.Exit(1)
|
||||
}
|
||||
defer pool.Release()
|
||||
|
||||
// Query each page
|
||||
for p := 1; p <= pages; p++ {
|
||||
search := &shodan.Search{
|
||||
Query: args[0],
|
||||
Page: p,
|
||||
Fields: fields,
|
||||
Separator: separator,
|
||||
Results: results,
|
||||
}
|
||||
|
||||
pool.Submit(func() {
|
||||
go search.Search()
|
||||
})
|
||||
}
|
||||
|
||||
// Get page result
|
||||
for j := 1; j <= pages*100; j++ {
|
||||
result := <-results
|
||||
if result != "" {
|
||||
fmt.Println(result)
|
||||
}
|
||||
}
|
||||
defer close(results)
|
||||
},
|
||||
}
|
||||
|
||||
func init() {
|
||||
// Add flags
|
||||
searchCmd.PersistentFlags().
|
||||
IntVarP(&pages, "pages", "p", 1, "Amount of pages to search")
|
||||
searchCmd.PersistentFlags().
|
||||
StringSliceVarP(&fields, "fields", "f", []string{}, "Field properties to filter")
|
||||
searchCmd.PersistentFlags().
|
||||
StringVarP(&separator, "separator", "s", "", "Separator between search properties")
|
||||
searchCmd.PersistentFlags().
|
||||
IntVarP(&threads, "threads", "t", 1, "Number of threads to use")
|
||||
|
||||
searchCmd.MarkFlagsRequiredTogether("fields", "separator")
|
||||
searchCmd.Flags().SortFlags = false
|
||||
}
|
20
cmd/shogo/commands/version.go
Normal file
20
cmd/shogo/commands/version.go
Normal file
@ -0,0 +1,20 @@
|
||||
package commands
|
||||
|
||||
import (
|
||||
"github.com/fatih/color"
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
const version = "0.1.0"
|
||||
|
||||
// Version command
|
||||
var versionCmd = &cobra.Command{
|
||||
Use: "version",
|
||||
Short: "Return shogo version",
|
||||
Run: func(_ *cobra.Command, _ []string) {
|
||||
utils.CheckColor()
|
||||
color.Red("%s\n", version)
|
||||
},
|
||||
}
|
9
cmd/shogo/main.go
Normal file
9
cmd/shogo/main.go
Normal file
@ -0,0 +1,9 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"git.tcp.direct/perp/shogo/cmd/shogo/commands"
|
||||
)
|
||||
|
||||
func main() {
|
||||
commands.Execute()
|
||||
}
|
19
go.mod
Normal file
19
go.mod
Normal file
@ -0,0 +1,19 @@
|
||||
module git.tcp.direct/perp/shogo
|
||||
|
||||
go 1.20
|
||||
|
||||
require (
|
||||
github.com/fatih/color v1.15.0
|
||||
github.com/ns3777k/go-shodan/v4 v4.2.0
|
||||
github.com/panjf2000/ants/v2 v2.8.1
|
||||
github.com/spf13/cobra v1.7.0
|
||||
)
|
||||
|
||||
require (
|
||||
github.com/google/go-querystring v1.0.0 // indirect
|
||||
github.com/inconshreveable/mousetrap v1.1.0 // indirect
|
||||
github.com/mattn/go-colorable v0.1.13 // indirect
|
||||
github.com/mattn/go-isatty v0.0.17 // indirect
|
||||
github.com/spf13/pflag v1.0.5 // indirect
|
||||
golang.org/x/sys v0.6.0 // indirect
|
||||
)
|
44
go.sum
Normal file
44
go.sum
Normal file
@ -0,0 +1,44 @@
|
||||
github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/fatih/color v1.15.0 h1:kOqh6YHBtK8aywxGerMG2Eq3H6Qgoqeo13Bk2Mv/nBs=
|
||||
github.com/fatih/color v1.15.0/go.mod h1:0h5ZqXfHYED7Bhv2ZJamyIOUej9KtShiJESRwBDUSsw=
|
||||
github.com/google/go-querystring v1.0.0 h1:Xkwi/a1rcvNg1PPYe5vI8GbeBY/jrVuDX5ASuANWTrk=
|
||||
github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
|
||||
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
|
||||
github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
|
||||
github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
|
||||
github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
|
||||
github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
|
||||
github.com/mattn/go-isatty v0.0.17 h1:BTarxUcIeDqL27Mc+vyvdWYSL28zpIhv3RoTdsLMPng=
|
||||
github.com/mattn/go-isatty v0.0.17/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
|
||||
github.com/ns3777k/go-shodan/v4 v4.2.0 h1:18R6axS4f+l37ic14BfjnmMo1dLgNTiPi6dtPXd9qwc=
|
||||
github.com/ns3777k/go-shodan/v4 v4.2.0/go.mod h1:7kSWq/PQ/JCH6U4k2YjXRmnJKfPaJZAhOSMgAXRB23U=
|
||||
github.com/panjf2000/ants/v2 v2.8.1 h1:C+n/f++aiW8kHCExKlpX6X+okmxKXP7DWLutxuAPuwQ=
|
||||
github.com/panjf2000/ants/v2 v2.8.1/go.mod h1:KIBmYG9QQX5U2qzFP/yQJaq/nSb6rahS9iEHkrCMgM8=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
|
||||
github.com/spf13/cobra v1.7.0 h1:hyqWnYt1ZQShIddO5kBpj3vu05/++x6tJ6dg8EC572I=
|
||||
github.com/spf13/cobra v1.7.0/go.mod h1:uLxZILRyS/50WlhOIKD7W6V5bgeIt+4sICxh6uRMrb0=
|
||||
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
|
||||
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
|
||||
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
|
||||
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
|
||||
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
|
||||
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
|
||||
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
|
||||
golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
|
||||
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.6.0 h1:MVltZSvRTcU2ljQOhs94SXPftV6DCNnZViHeQps87pQ=
|
||||
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
38
internal/shodan/alert/clear.go
Normal file
38
internal/shodan/alert/clear.go
Normal file
@ -0,0 +1,38 @@
|
||||
package alert
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Clear all alerts
|
||||
func Clear() {
|
||||
// Get results
|
||||
results, err := utils.Client.GetAlerts(context.Background())
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
utils.Title.Println("Clearing alerts...")
|
||||
|
||||
for index := range results {
|
||||
// Set results
|
||||
result, err := utils.Client.DeleteAlert(context.Background(), results[index].ID)
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Print results
|
||||
if result {
|
||||
fmt.Printf("%s: %s\n", utils.Green("Deleted alert"), utils.Blue(results[index].ID))
|
||||
} else {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), "failed deleting an alert")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Todo: Make this threaded
|
24
internal/shodan/alert/create.go
Normal file
24
internal/shodan/alert/create.go
Normal file
@ -0,0 +1,24 @@
|
||||
package alert
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Create an alert
|
||||
func Create(name, ip string) {
|
||||
host := []string{ip}
|
||||
|
||||
// Get results
|
||||
results, err := utils.Client.CreateAlert(context.Background(), name, host, 0)
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Print results
|
||||
utils.Title.Println("Successfully created alert!")
|
||||
fmt.Printf("%s: %s\n", utils.Green("Alert ID"), utils.Blue(results.ID))
|
||||
}
|
25
internal/shodan/alert/delete.go
Normal file
25
internal/shodan/alert/delete.go
Normal file
@ -0,0 +1,25 @@
|
||||
package alert
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Delete an alert
|
||||
func Delete(id string) {
|
||||
// Set results
|
||||
results, err := utils.Client.DeleteAlert(context.Background(), id)
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Print results
|
||||
if results {
|
||||
utils.Title.Println("Successfully deleted alert!")
|
||||
} else {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), "alert does not exist")
|
||||
}
|
||||
}
|
29
internal/shodan/alert/info.go
Normal file
29
internal/shodan/alert/info.go
Normal file
@ -0,0 +1,29 @@
|
||||
package alert
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Return alert information
|
||||
func Info(id string) {
|
||||
// Get results
|
||||
results, err := utils.Client.GetAlert(context.Background(), id)
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Print results
|
||||
utils.Title.Printf("Alert %s\n", id)
|
||||
fmt.Printf("%s: %s\n", utils.Green("Name"), utils.Blue(results.Name))
|
||||
fmt.Printf(
|
||||
"%s: %s\n",
|
||||
utils.Blue("Network"),
|
||||
utils.Green(strings.Join(results.Filters.IP, ",")),
|
||||
)
|
||||
fmt.Printf("%s: %s\n", utils.Green("Created"), utils.Blue(results.Created))
|
||||
}
|
31
internal/shodan/alert/list.go
Normal file
31
internal/shodan/alert/list.go
Normal file
@ -0,0 +1,31 @@
|
||||
package alert
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Return all the active alerts
|
||||
func List() {
|
||||
// Get results
|
||||
results, err := utils.Client.GetAlerts(context.Background())
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Print results
|
||||
utils.Title.Println("Alert ID\t\tName\t\t\tIP/Network")
|
||||
|
||||
for index := range results {
|
||||
fmt.Printf(
|
||||
"%s\t%s\t%s\n",
|
||||
utils.Green(results[index].ID),
|
||||
utils.Blue(results[index].Name),
|
||||
utils.Blue(strings.Join(results[index].Filters.IP, ",")),
|
||||
)
|
||||
}
|
||||
}
|
30
internal/shodan/count.go
Normal file
30
internal/shodan/count.go
Normal file
@ -0,0 +1,30 @@
|
||||
package shodan
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
"github.com/ns3777k/go-shodan/v4/shodan"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Return your query result count
|
||||
func Count(query string) {
|
||||
// Setup query
|
||||
options := &shodan.HostQueryOptions{
|
||||
Query: query,
|
||||
}
|
||||
|
||||
// Get results
|
||||
results, err := utils.Client.GetHostsCountForQuery(context.Background(), options)
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// Print results
|
||||
utils.Title.Printf("Count: %s\n", query)
|
||||
fmt.Printf("%s\n", utils.Blue(results.Total))
|
||||
}
|
43
internal/shodan/domain.go
Normal file
43
internal/shodan/domain.go
Normal file
@ -0,0 +1,43 @@
|
||||
package shodan
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"net"
|
||||
|
||||
"github.com/ns3777k/go-shodan/v4/shodan"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Return domain information
|
||||
func Domain(host string) {
|
||||
// Parse IP
|
||||
ips, err := net.LookupIP(host)
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Get results
|
||||
results, err := utils.Client.GetServicesForHost(
|
||||
context.Background(),
|
||||
ips[0].To4().String(),
|
||||
&shodan.HostServicesOptions{},
|
||||
)
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Print results
|
||||
utils.Title.Printf("Domain: %s", host)
|
||||
|
||||
fmt.Printf("\n\n")
|
||||
|
||||
for index := range results.Data {
|
||||
fmt.Println(results.Data[index].Domains)
|
||||
}
|
||||
}
|
||||
|
||||
// Todo: Find domain records
|
75
internal/shodan/host.go
Normal file
75
internal/shodan/host.go
Normal file
@ -0,0 +1,75 @@
|
||||
package shodan
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/ns3777k/go-shodan/v4/shodan"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Return host information
|
||||
func Host(ip string) {
|
||||
// Get results
|
||||
results, err := utils.Client.GetServicesForHost(
|
||||
context.Background(),
|
||||
ip,
|
||||
&shodan.HostServicesOptions{},
|
||||
)
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Print results
|
||||
utils.Title.Printf("Host: %s\n", ip)
|
||||
fmt.Printf(
|
||||
"%s: %s\n",
|
||||
utils.Green("Hostnames"),
|
||||
utils.Blue(strings.Join(results.Hostnames, ",")),
|
||||
)
|
||||
fmt.Printf("%s: %s\n", utils.Blue("Organization"), utils.Green(results.Organization))
|
||||
fmt.Printf("%s: %s\n", utils.Green("Country"), utils.Blue(results.Country))
|
||||
fmt.Printf("%s: %s\n", utils.Blue("City"), utils.Green(results.City))
|
||||
fmt.Printf("%s: %s\n", utils.Green("Updated"), utils.Blue(results.LastUpdate))
|
||||
fmt.Printf("%s: %s\n", utils.Blue("Port count"), utils.Green(len(results.Ports)))
|
||||
fmt.Printf("\n%s:\n", utils.Green("Ports"))
|
||||
|
||||
// Color alternator & current line
|
||||
var alternate bool
|
||||
var line string
|
||||
|
||||
for index := range results.Data {
|
||||
// Alternate between colors
|
||||
// Find each port & transport
|
||||
if alternate {
|
||||
alternate = false
|
||||
line = fmt.Sprintf(
|
||||
"\t%s/%s",
|
||||
utils.Blue(results.Data[index].Port),
|
||||
utils.Green(results.Data[index].Transport),
|
||||
)
|
||||
} else if !alternate {
|
||||
alternate = true
|
||||
line = fmt.Sprintf(
|
||||
"\t%s/%s",
|
||||
utils.Green(results.Data[index].Port),
|
||||
utils.Blue(results.Data[index].Transport),
|
||||
)
|
||||
}
|
||||
|
||||
// Find each product
|
||||
if results.Data[index].Product != "" {
|
||||
if alternate {
|
||||
line = fmt.Sprintf("%s (%s)", line, utils.Green(results.Data[index].Product))
|
||||
} else if !alternate {
|
||||
line = fmt.Sprintf("%s (%s)", line, utils.Blue(results.Data[index].Product))
|
||||
}
|
||||
}
|
||||
|
||||
// Print results
|
||||
fmt.Println(line)
|
||||
}
|
||||
}
|
50
internal/shodan/info.go
Normal file
50
internal/shodan/info.go
Normal file
@ -0,0 +1,50 @@
|
||||
package shodan
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Return your account information
|
||||
func Info(api_enabled, profile_enabled bool) {
|
||||
// Fetch API information
|
||||
if api_enabled {
|
||||
results, err := utils.Client.GetAPIInfo(context.Background())
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Print results
|
||||
utils.Title.Println("API")
|
||||
fmt.Printf("%s: %s\n", utils.Green("Plan"), utils.Blue(results.Plan))
|
||||
fmt.Printf("%s: %s\n", utils.Blue("Query credits"), utils.Green(results.QueryCredits))
|
||||
fmt.Printf("%s: %s\n", utils.Green("Scan credits"), utils.Blue(results.ScanCredits))
|
||||
fmt.Printf("%s: %s\n", utils.Blue("Telnet"), utils.Green(results.Telnet))
|
||||
fmt.Printf("%s: %s\n", utils.Green("HTTPS"), utils.Blue(results.HTTPS))
|
||||
fmt.Printf("%s: %s\n", utils.Blue("Unlocked"), utils.Green(results.Unlocked))
|
||||
}
|
||||
|
||||
// Add newline
|
||||
if api_enabled && profile_enabled {
|
||||
fmt.Println("")
|
||||
}
|
||||
|
||||
// Fetch profile information
|
||||
if profile_enabled {
|
||||
results, err := utils.Client.GetAccountProfile(context.Background())
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Print results
|
||||
utils.Title.Println("Profile")
|
||||
fmt.Printf("%s: %s\n", utils.Green("Name"), utils.Blue(results.Name))
|
||||
fmt.Printf("%s: %s\n", utils.Blue("Member"), utils.Green(results.Member))
|
||||
fmt.Printf("%s: %s\n", utils.Green("Credits"), utils.Blue(results.Credits))
|
||||
fmt.Printf("%s: %s\n", utils.Blue("Created"), utils.Green(results.Created))
|
||||
}
|
||||
}
|
21
internal/shodan/myip.go
Normal file
21
internal/shodan/myip.go
Normal file
@ -0,0 +1,21 @@
|
||||
package shodan
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Return your IP address
|
||||
func MyIp() {
|
||||
// Fetch IP address
|
||||
results, err := utils.Client.GetMyIP(context.Background())
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// Print results
|
||||
fmt.Printf("%s\n", utils.Blue(results.String()))
|
||||
}
|
112
internal/shodan/search.go
Normal file
112
internal/shodan/search.go
Normal file
@ -0,0 +1,112 @@
|
||||
package shodan
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/ns3777k/go-shodan/v4/shodan"
|
||||
|
||||
"git.tcp.direct/perp/shogo/internal/utils"
|
||||
)
|
||||
|
||||
// Search query
|
||||
type Search struct {
|
||||
Query string // Search query
|
||||
Page int // Current page
|
||||
Fields []string // Filter fields
|
||||
Separator string // Filter separator
|
||||
Results chan string // Results channel
|
||||
}
|
||||
|
||||
// Return shodan search results
|
||||
func (s *Search) Search() {
|
||||
// Setup options
|
||||
options := &shodan.HostQueryOptions{
|
||||
Query: s.Query,
|
||||
Page: s.Page,
|
||||
Minify: false,
|
||||
}
|
||||
|
||||
// Get results
|
||||
results, err := utils.Client.GetHostsForQuery(context.Background(), options)
|
||||
if err != nil {
|
||||
fmt.Printf("%s: %s\n", utils.Red("Error"), err.Error())
|
||||
s.Results <- ""
|
||||
return
|
||||
}
|
||||
|
||||
// More than 2 matches
|
||||
if len(results.Matches) > 2 {
|
||||
// Go through matches
|
||||
for match := range results.Matches {
|
||||
if len(s.Fields) != 0 {
|
||||
fields := map[string]string{
|
||||
"product": results.Matches[match].Product,
|
||||
"ip_str": results.Matches[match].IP.String(),
|
||||
"org": results.Matches[match].Organization,
|
||||
"isp": results.Matches[match].ISP,
|
||||
"transport": results.Matches[match].Transport,
|
||||
"data": results.Matches[match].Data,
|
||||
"asn": results.Matches[match].ASN,
|
||||
"port": strconv.Itoa(results.Matches[match].Port),
|
||||
"timestamp": results.Matches[match].Timestamp,
|
||||
"os": results.Matches[match].OS,
|
||||
}
|
||||
|
||||
var result string
|
||||
var content string
|
||||
|
||||
// Go through custom fields
|
||||
for key, value := range fields {
|
||||
// Go through real fields
|
||||
for index := range s.Fields {
|
||||
// Real field matched custom field
|
||||
if s.Fields[index] == key {
|
||||
// Port may go on the wrong side
|
||||
if key == "port" {
|
||||
content += value
|
||||
} else {
|
||||
content += value + s.Separator
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
lines := strings.Split(content, "\n")
|
||||
for line := range lines {
|
||||
result += strings.TrimRight(lines[line], ":")
|
||||
}
|
||||
|
||||
// Print results
|
||||
fmt.Println(result)
|
||||
|
||||
} else {
|
||||
// Send results
|
||||
content := fmt.Sprintf("%s: %s\n%s: %s\n%s: %s\n",
|
||||
utils.Green("IP"), utils.Blue(results.Matches[match].IP.String()),
|
||||
utils.Blue("Port"), utils.Green(results.Matches[match].Port),
|
||||
utils.Green("Hostname"), utils.Blue(strings.Join(results.Matches[0].Hostnames, ",")),
|
||||
)
|
||||
|
||||
lines := strings.Split(results.Matches[match].Data, "\n")
|
||||
green := true
|
||||
for line := range lines {
|
||||
values := strings.Split(lines[line], ":")
|
||||
if green {
|
||||
content += fmt.Sprintf("%s:%s\n", utils.Green(values[0]), utils.Blue(strings.Join(values[1:], "")))
|
||||
green = false
|
||||
} else {
|
||||
content += fmt.Sprintf("%s:%s\n", utils.Blue(values[0]), utils.Green(strings.Join(values[1:], "")))
|
||||
green = true
|
||||
}
|
||||
}
|
||||
|
||||
s.Results <- content
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Todo: Change pages to limit, redo field filtering
|
19
internal/utils/colors.go
Normal file
19
internal/utils/colors.go
Normal file
@ -0,0 +1,19 @@
|
||||
package utils
|
||||
|
||||
import "github.com/fatih/color"
|
||||
|
||||
var (
|
||||
// Colors
|
||||
Title = color.New(color.FgRed).Add(color.Bold)
|
||||
Red = color.New(color.FgRed).Add(color.Bold).SprintFunc()
|
||||
Green = color.New(color.FgGreen).SprintFunc()
|
||||
Blue = color.New(color.FgBlue).SprintFunc()
|
||||
Disabled = false
|
||||
)
|
||||
|
||||
// Disable colors
|
||||
func CheckColor() {
|
||||
if Disabled {
|
||||
color.NoColor = true
|
||||
}
|
||||
}
|
20
internal/utils/read.go
Normal file
20
internal/utils/read.go
Normal file
@ -0,0 +1,20 @@
|
||||
package utils
|
||||
|
||||
import "os"
|
||||
|
||||
// Return the API key
|
||||
func getKey() (string, error) {
|
||||
// Get config directory
|
||||
config, err := os.UserConfigDir()
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
// Read the file
|
||||
content, err := os.ReadFile(config + "/shodan/api_key")
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
return string(content), nil
|
||||
}
|
22
internal/utils/shodan.go
Normal file
22
internal/utils/shodan.go
Normal file
@ -0,0 +1,22 @@
|
||||
package utils
|
||||
|
||||
import (
|
||||
"os"
|
||||
|
||||
"github.com/ns3777k/go-shodan/v4/shodan"
|
||||
)
|
||||
|
||||
// Client
|
||||
var Client *shodan.Client
|
||||
|
||||
func init() {
|
||||
// Get API key
|
||||
key, err := getKey()
|
||||
if err != nil {
|
||||
Red("Error: %s", err.Error())
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// Setup client
|
||||
Client = shodan.NewClient(nil, key)
|
||||
}
|
Loading…
Reference in New Issue
Block a user