initial commit
This commit is contained in:
commit
e660b4676d
10
.gitignore
vendored
Normal file
10
.gitignore
vendored
Normal file
@ -0,0 +1,10 @@
|
||||
.gitleaks/
|
||||
.pre-commit/
|
||||
*.exe
|
||||
*.exe~
|
||||
*.dll
|
||||
*.so
|
||||
*.dylib
|
||||
*.DS_STORE
|
||||
*.idea
|
||||
*.got
|
6
.pre-commit-hooks.yaml
Normal file
6
.pre-commit-hooks.yaml
Normal file
@ -0,0 +1,6 @@
|
||||
- id: gitleaks-template-report
|
||||
name: Gitleaks HTML Report (custom template)
|
||||
entry: ./gitleaks_scan.py
|
||||
language: script
|
||||
types: [file]
|
||||
args: []
|
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>.
|
99
README.es.md
Normal file
99
README.es.md
Normal file
@ -0,0 +1,99 @@
|
||||
# 🔍 Gitleaks Pre-commit Hook
|
||||
|
||||
Este hook personalizado ejecuta [Gitleaks](https://github.com/gitleaks/gitleaks) para generar reportes en **HTML** (usando plantillas) o **JSON**, con reglas configurables.
|
||||
|
||||
## 🚀 Uso
|
||||
|
||||
Agregá este repo en tu `.pre-commit-config.yaml`:
|
||||
|
||||
```yaml
|
||||
- repo: https://git.fridu.us/heckyel/gitleaks-pre-commit-hook
|
||||
rev: v1.0.0
|
||||
hooks:
|
||||
- id: gitleaks-template-report
|
||||
# Uso básico (reglas por defecto de gitleaks)
|
||||
args: ["--format=html"]
|
||||
|
||||
# Con reglas internas desde este repo
|
||||
# args: ["--format=html", "--rules-internal"]
|
||||
|
||||
# Con reglas externas
|
||||
# args: ["--format=html", "--rules-external", "--config=ruta/a/gitleaks.toml"]
|
||||
```
|
||||
|
||||
> ⚠️ Si usás `--format=json`, no es necesario `--template`.
|
||||
|
||||
---
|
||||
|
||||
### 🧩 Parámetros disponibles
|
||||
|
||||
| Parámetro | Descripción |
|
||||
| -------------------- | ----------------------------------------------------------------------------|
|
||||
| `--template=NOMBRE` | Elige la plantilla HTML a usar (por defecto: `leet`) |
|
||||
| `--format=html\|json` | Formato de salida del reporte (`html` por defecto, o `json`) |
|
||||
| `--redact` | Oculta los secretos detectados con `***` en el reporte |
|
||||
| `--force` | Fuerza la reinstalación de Gitleaks (útil para debugging o versiones rotas) |
|
||||
| `--version=VERSIÓN` | Versión de Gitleaks a instalar (por defecto: `v8.27.0`) |
|
||||
| `--rules-internal` | Usa el archivo de reglas interno (`rules/gitleaks.toml`) |
|
||||
| `--rules-external` | Requiere `--config` para especificar un archivo de reglas externo |
|
||||
| `--config=archivo` | Ruta a archivo de reglas personalizado (requiere `--rules-external`) |
|
||||
|
||||
**Comportamiento de las reglas:**
|
||||
|
||||
- Por defecto: Usa solo las reglas incorporadas de gitleaks
|
||||
- Con `--rules-internal`: Usa el archivo de reglas interno
|
||||
- Con `--rules-external --config=archivo`: Usa el archivo de reglas externo especificado
|
||||
|
||||
---
|
||||
|
||||
### 🎨 Plantillas disponibles (`--format=html`)
|
||||
|
||||
| Nombre | Archivo generado |
|
||||
| --------- | ----------------------------- |
|
||||
| `leet` | `.pre-commit/gitleaks/report/index.html` |
|
||||
| `basic` | `.pre-commit/gitleaks/report/index.html` |
|
||||
| `myspace` | `.pre-commit/gitleaks/report/index.html` |
|
||||
| `w98` | `.pre-commit/gitleaks/report/index.html` |
|
||||
| `wxp` | `.pre-commit/gitleaks/report/index.html` |
|
||||
|
||||
> ⚠️ El archivo generado siempre se llama `index.html`, sin importar la plantilla usada.
|
||||
|
||||
---
|
||||
|
||||
### 📂 Salida esperada
|
||||
|
||||
**Formato HTML:**
|
||||
|
||||
```sh
|
||||
.pre-commit/gitleaks/report/
|
||||
├── index.html
|
||||
```
|
||||
|
||||
**Formato JSON:**
|
||||
|
||||
```sh
|
||||
.pre-commit/gitleaks/report/
|
||||
├── report.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✅ Requisitos
|
||||
|
||||
- Tener `gitleaks` instalado y disponible en tu `PATH`
|
||||
- El archivo de reglas debe existir solo si se usa con `--rules-external`
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Configuración para desarrollo
|
||||
|
||||
```bash
|
||||
pre-commit install
|
||||
pre-commit run --all-files
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📝 Licencia
|
||||
|
||||
[GNUv3 or later](LICENSE)
|
99
README.md
Normal file
99
README.md
Normal file
@ -0,0 +1,99 @@
|
||||
# 🔍 Gitleaks Pre-commit Hook
|
||||
|
||||
This custom pre-commit hook runs [Gitleaks](https://github.com/gitleaks/gitleaks) to generate reports in **HTML** (using customizable templates) or **JSON**, with optional rules.
|
||||
|
||||
## 🚀 Usage
|
||||
|
||||
Add this repo to your `.pre-commit-config.yaml`:
|
||||
|
||||
```yaml
|
||||
- repo: https://git.fridu.us/heckyel/gitleaks-pre-commit-hook
|
||||
rev: v1.0.0
|
||||
hooks:
|
||||
- id: gitleaks-template-report
|
||||
# Basic usage (default gitleaks rules)
|
||||
args: ["--format=html"]
|
||||
|
||||
# With internal rules from this repo
|
||||
# args: ["--format=html", "--rules-internal"]
|
||||
|
||||
# With external rules
|
||||
# args: ["--format=html", "--rules-external", "--config=path/to/gitleaks.toml"]
|
||||
```
|
||||
|
||||
> ⚠️ When using `--format=json`, the `--template` option is ignored.
|
||||
|
||||
---
|
||||
|
||||
### 🧩 Available parameters
|
||||
|
||||
| Parameter | Description |
|
||||
| --------------------- | ------------------------------------------------------------------------------- |
|
||||
| `--template=NAME` | Choose the HTML report template (default: `leet`) |
|
||||
| `--format=html\|json` | Output format (`html` by default, or `json`) |
|
||||
| `--redact` | Redacts detected secrets (replaces them with `***`) in reports |
|
||||
| `--force` | Forces the reinstallation of Gitleaks (useful for debugging or broken versions) |
|
||||
| `--version=VERSION` | Specifies the version of Gitleaks to install (default: `v8.27.0`) |
|
||||
| `--rules-internal` | Uses the internal rules file (`rules/gitleaks.toml`) |
|
||||
| `--rules-external` | Requires `--config` to specify an external rules file |
|
||||
| `--config=FILE` | Path to custom rules file (requires `--rules-external`) |
|
||||
|
||||
**Rules Behavior:**
|
||||
|
||||
- By default: Uses gitleaks' built-in rules only
|
||||
- With `--rules-internal`: Uses the internal rules file
|
||||
- With `--rules-external --config=FILE`: Uses the specified external rules file
|
||||
|
||||
---
|
||||
|
||||
### 🎨 Available HTML templates (`--format=html`)
|
||||
|
||||
| Template name | Output file |
|
||||
| ------------- | ----------------------------- |
|
||||
| `leet` | `.pre-commit/gitleaks/report/index.html` |
|
||||
| `basic` | `.pre-commit/gitleaks/report/index.html` |
|
||||
| `myspace` | `.pre-commit/gitleaks/report/index.html` |
|
||||
| `w98` | `.pre-commit/gitleaks/report/index.html` |
|
||||
| `wxp` | `.pre-commit/gitleaks/report/index.html` |
|
||||
|
||||
> ⚠️ The output file is always named `index.html` regardless of the selected template.
|
||||
|
||||
---
|
||||
|
||||
### 📂 Output files
|
||||
|
||||
**HTML format:**
|
||||
|
||||
```sh
|
||||
.pre-commit/gitleaks/report/
|
||||
├── index.html
|
||||
```
|
||||
|
||||
**JSON format:**
|
||||
|
||||
```sh
|
||||
.pre-commit/gitleaks/report/
|
||||
├── report.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✅ Requirements
|
||||
|
||||
- `gitleaks` must be installed and available in your `PATH`
|
||||
- The rules file must exist if specified via `--config` with `--rules-external`
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Dev setup
|
||||
|
||||
```bash
|
||||
pre-commit install
|
||||
pre-commit run --all-files
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📝 License
|
||||
|
||||
[GNUv3 or later](LICENSE)
|
242
gitleaks_scan.py
Executable file
242
gitleaks_scan.py
Executable file
@ -0,0 +1,242 @@
|
||||
#!/usr/bin/python3
|
||||
|
||||
import os
|
||||
import sys
|
||||
import subprocess
|
||||
import tempfile
|
||||
import shutil
|
||||
|
||||
USER_VERSION = "8.27.0"
|
||||
FORCE_INSTALL = False
|
||||
SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))
|
||||
|
||||
def parse_args():
|
||||
global USER_VERSION, FORCE_INSTALL
|
||||
args = sys.argv[1:]
|
||||
new_args = []
|
||||
while args:
|
||||
arg = args.pop(0)
|
||||
if arg.startswith("--version="):
|
||||
USER_VERSION = arg.split("=", 1)[1].lstrip("v")
|
||||
elif arg == "--force":
|
||||
FORCE_INSTALL = True
|
||||
else:
|
||||
new_args.append(arg)
|
||||
return new_args
|
||||
|
||||
def is_gitleaks_installed():
|
||||
try:
|
||||
result = subprocess.run(["gitleaks", "version"], capture_output=True, text=True)
|
||||
return result.returncode == 0
|
||||
except FileNotFoundError:
|
||||
return False
|
||||
|
||||
def get_installed_version():
|
||||
try:
|
||||
result = subprocess.run(["gitleaks", "version"], capture_output=True, text=True)
|
||||
if result.returncode != 0:
|
||||
return None
|
||||
version = result.stdout.strip()
|
||||
if version.startswith("v"):
|
||||
version = version[1:]
|
||||
return version
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
def get_platform_and_arch():
|
||||
import platform
|
||||
system = platform.system().lower()
|
||||
machine = platform.machine().lower()
|
||||
|
||||
if system.startswith("linux"):
|
||||
plat = "linux"
|
||||
elif system == "darwin":
|
||||
plat = "darwin"
|
||||
elif system == "windows":
|
||||
plat = "windows"
|
||||
elif "mingw" in os.environ.get("MSYSTEM", "").lower():
|
||||
plat = "windows"
|
||||
else:
|
||||
print(f"[!] Unsupported operating system: {system}")
|
||||
sys.exit(1)
|
||||
|
||||
if machine in ["x86_64", "amd64"]:
|
||||
arch = "x64"
|
||||
elif machine in ["arm64", "aarch64"]:
|
||||
arch = "arm64"
|
||||
elif machine.startswith("armv7"):
|
||||
arch = "armv7"
|
||||
elif machine == "i386":
|
||||
arch = "x32"
|
||||
elif machine == "armv6":
|
||||
arch = "armv6"
|
||||
else:
|
||||
print(f"[!] Unsupported architecture: {machine}")
|
||||
sys.exit(1)
|
||||
|
||||
if plat == "windows" and arch not in ["x32", "x64", "armv6", "armv7"]:
|
||||
print(f"[!] Unsupported Windows architecture: {arch}")
|
||||
sys.exit(1)
|
||||
|
||||
return plat, arch
|
||||
|
||||
def install_gitleaks(version, force):
|
||||
installed = is_gitleaks_installed()
|
||||
current_version = get_installed_version()
|
||||
|
||||
if installed and not force:
|
||||
if current_version == version:
|
||||
return
|
||||
else:
|
||||
print(f"Gitleaks {current_version} is installed, but version {version} is required.")
|
||||
print(" Use --force to reinstall.")
|
||||
return
|
||||
|
||||
print(f"Installing Gitleaks v{version}...")
|
||||
plat, arch = get_platform_and_arch()
|
||||
|
||||
ext = "zip" if plat == "windows" else "tar.gz"
|
||||
filename = f"gitleaks_{version}_{plat}_{arch}.{ext}"
|
||||
url = f"https://github.com/gitleaks/gitleaks/releases/download/v{version}/{filename}"
|
||||
|
||||
with tempfile.TemporaryDirectory() as tmpdir:
|
||||
archive_path = os.path.join(tmpdir, filename)
|
||||
print(f"Downloading from: {url}")
|
||||
subprocess.run(["curl", "-sSL", "-o", archive_path, url], check=True)
|
||||
|
||||
if ext == "zip":
|
||||
import zipfile
|
||||
with zipfile.ZipFile(archive_path, "r") as zip_ref:
|
||||
zip_ref.extractall(tmpdir)
|
||||
else:
|
||||
subprocess.run(["tar", "-xzf", archive_path, "-C", tmpdir], check=True)
|
||||
|
||||
exe_name = "gitleaks.exe" if plat == "windows" else "gitleaks"
|
||||
gitleaks_bin = os.path.join(tmpdir, exe_name)
|
||||
|
||||
if plat == "windows":
|
||||
fallback = os.path.expanduser("~/.local/bin")
|
||||
os.makedirs(fallback, exist_ok=True)
|
||||
dest_path = os.path.join(fallback, exe_name)
|
||||
shutil.move(gitleaks_bin, dest_path)
|
||||
print(f"Gitleaks v{version} installed at {dest_path}")
|
||||
print("Add ~/.local/bin to your PATH if not already present.")
|
||||
else:
|
||||
install_path = "/usr/local/bin/gitleaks"
|
||||
|
||||
elevate_cmd = None
|
||||
if shutil.which("sudo"):
|
||||
elevate_cmd = "sudo"
|
||||
elif shutil.which("doas"):
|
||||
elevate_cmd = "doas"
|
||||
|
||||
if elevate_cmd:
|
||||
print(f"Installing with {elevate_cmd} at {install_path}...")
|
||||
try:
|
||||
subprocess.run([elevate_cmd, "mv", gitleaks_bin, install_path], check=True)
|
||||
subprocess.run([elevate_cmd, "chmod", "+x", install_path], check=True)
|
||||
print(f"Gitleaks v{version} installed at {install_path}")
|
||||
except subprocess.CalledProcessError:
|
||||
print(f"Error moving file with {elevate_cmd}. Installing locally...")
|
||||
fallback = os.path.expanduser("~/.local/bin")
|
||||
os.makedirs(fallback, exist_ok=True)
|
||||
shutil.move(gitleaks_bin, os.path.join(fallback, "gitleaks"))
|
||||
print(f"Gitleaks v{version} installed at {fallback}")
|
||||
print("Ensure ~/.local/bin is in your PATH")
|
||||
else:
|
||||
print("Neither 'sudo' nor 'doas' available. Installing locally...")
|
||||
fallback = os.path.expanduser("~/.local/bin")
|
||||
os.makedirs(fallback, exist_ok=True)
|
||||
shutil.move(gitleaks_bin, os.path.join(fallback, "gitleaks"))
|
||||
print(f"Gitleaks v{version} installed at {fallback}")
|
||||
print("Ensure ~/.local/bin is in your PATH")
|
||||
|
||||
def main():
|
||||
args = parse_args()
|
||||
|
||||
install_gitleaks(USER_VERSION, FORCE_INSTALL)
|
||||
|
||||
# hook variables
|
||||
TEMPLATE_NAME = "leet"
|
||||
CONFIG_FILE_NAME = "gitleaks.toml"
|
||||
FORMAT = "html"
|
||||
REDACT = False
|
||||
config_path = None
|
||||
use_internal_rules = False
|
||||
use_external_rules = False
|
||||
|
||||
for arg in args:
|
||||
if arg.startswith("--template="):
|
||||
TEMPLATE_NAME = arg.split("=",1)[1]
|
||||
elif arg.startswith("--config="):
|
||||
config_path = arg.split("=",1)[1]
|
||||
elif arg.startswith("--format="):
|
||||
FORMAT = arg.split("=",1)[1]
|
||||
elif arg == "--redact":
|
||||
REDACT = True
|
||||
elif arg == "--rules-internal":
|
||||
use_internal_rules = True
|
||||
elif arg == "--rules-external":
|
||||
use_external_rules = True
|
||||
|
||||
# By default, don't use any config file unless explicitly specified
|
||||
if not (use_internal_rules or use_external_rules):
|
||||
config_path = None
|
||||
elif not config_path:
|
||||
if use_internal_rules:
|
||||
config_path = os.path.join(SCRIPT_DIR, "rules", CONFIG_FILE_NAME)
|
||||
elif use_external_rules:
|
||||
# You might want to specify a default external rules path here
|
||||
print("Error: --rules-external requires a config file path with --config=")
|
||||
sys.exit(1)
|
||||
|
||||
template_path = os.path.join(SCRIPT_DIR, "templates", f"{TEMPLATE_NAME}.tmpl")
|
||||
report_dir = os.path.join(".pre-commit", "gitleaks", "report")
|
||||
os.makedirs(report_dir, exist_ok=True)
|
||||
|
||||
if FORMAT not in ("html", "json"):
|
||||
print(f"Unsupported format: {FORMAT}")
|
||||
print(" Supported formats: html, json")
|
||||
sys.exit(1)
|
||||
|
||||
if config_path and not os.path.isfile(config_path):
|
||||
print(f"Config file not found: {config_path}")
|
||||
sys.exit(1)
|
||||
|
||||
extra_args = []
|
||||
if config_path:
|
||||
extra_args.append(f"--config={config_path}")
|
||||
if REDACT:
|
||||
extra_args.append("--redact")
|
||||
|
||||
if FORMAT == "html":
|
||||
if not os.path.isfile(template_path):
|
||||
print(f"Template not found: {template_path}")
|
||||
sys.exit(1)
|
||||
report_path = os.path.join(report_dir, "index.html")
|
||||
cmd = ["gitleaks", "git"] + extra_args + [
|
||||
"--report-format=template",
|
||||
f"--report-template={template_path}",
|
||||
f"--report-path={report_path}"
|
||||
]
|
||||
else:
|
||||
report_path = os.path.join(report_dir, "report.json")
|
||||
cmd = ["gitleaks", "git"] + extra_args + [
|
||||
"--report-format=json",
|
||||
f"--report-path={report_path}"
|
||||
]
|
||||
|
||||
print(f"Running: {' '.join(cmd)}")
|
||||
result = subprocess.run(cmd)
|
||||
if result.returncode != 0:
|
||||
print("Error running gitleaks.")
|
||||
sys.exit(result.returncode)
|
||||
|
||||
if os.path.isfile(report_path):
|
||||
print(f"Report generated: {report_path}")
|
||||
else:
|
||||
print("Failed to generate report.")
|
||||
sys.exit(1)
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
3137
rules/gitleaks.toml
Normal file
3137
rules/gitleaks.toml
Normal file
File diff suppressed because it is too large
Load Diff
760
templates/basic.tmpl
Normal file
760
templates/basic.tmpl
Normal file
@ -0,0 +1,760 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Gitleaks Security Findings Report</title>
|
||||
<style>
|
||||
:root {
|
||||
--primary-color: #2563eb;
|
||||
--primary-color-rgb: 37, 99, 235;
|
||||
--primary-dark: #1d4ed8;
|
||||
--primary-light: #3b82f6;
|
||||
--secondary-color: #f3f4f6;
|
||||
--surface-color: #ffffff;
|
||||
--border-color: #e5e7eb;
|
||||
--text-color: #374151;
|
||||
--text-light: #6b7280;
|
||||
--text-inverse: #ffffff;
|
||||
--error-color: #ef4444;
|
||||
--warning-color: #f59e0b;
|
||||
--success-color: #10b981;
|
||||
--highlight-color: rgba(255, 255, 0, 0.2);
|
||||
--highlight-secret: rgba(239, 68, 68, 0.2);
|
||||
--shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
||||
--radius: 0;
|
||||
--font-mono: 'Fira Code', 'IBM Plex Mono', 'Source Code Pro', monospace;
|
||||
--font-main: 'IBM Plex Sans', 'Roboto Mono', monospace;
|
||||
}
|
||||
|
||||
body.dark-mode {
|
||||
--primary-color: #1e40af;
|
||||
--primary-dark: #1e3a8a;
|
||||
--primary-light: #3b82f6;
|
||||
--secondary-color: #1f2937;
|
||||
--surface-color: #111827;
|
||||
--border-color: #374151;
|
||||
--text-color: #f3f4f6;
|
||||
--text-light: #9ca3af;
|
||||
--text-inverse: #111827;
|
||||
--highlight-color: rgba(255, 255, 0, 0.3);
|
||||
--highlight-secret: rgba(255, 99, 99, 0.3);
|
||||
}
|
||||
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
html, body {
|
||||
height: 100%;
|
||||
font-family: var(--font-main);
|
||||
font-size: 16px;
|
||||
line-height: 1.5;
|
||||
color: var(--text-color);
|
||||
background-color: var(--surface-color);
|
||||
}
|
||||
|
||||
.app-container {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
height: 100%;
|
||||
max-width: 100%;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.app-header {
|
||||
height: 60px;
|
||||
background-color: var(--primary-color);
|
||||
color: var(--text-inverse);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
padding: 0 1.5rem;
|
||||
flex-shrink: 0;
|
||||
box-shadow: var(--shadow);
|
||||
z-index: 10;
|
||||
}
|
||||
|
||||
.logo h1 {
|
||||
font-size: 1.5rem;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.header-actions {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.btn {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
padding: 0.5rem 1rem;
|
||||
border-radius: var(--radius);
|
||||
font-size: 0.875rem;
|
||||
font-weight: 500;
|
||||
cursor: pointer;
|
||||
transition: background-color 0.2s, color 0.2s;
|
||||
border: none;
|
||||
font-family: var(--font-main);
|
||||
}
|
||||
|
||||
.btn-primary {
|
||||
background-color: var(--primary-color);
|
||||
color: var(--text-inverse);
|
||||
}
|
||||
|
||||
.btn-primary:hover {
|
||||
background-color: var(--primary-dark);
|
||||
}
|
||||
|
||||
.btn-sm {
|
||||
padding: 0.25rem 0.5rem;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.app-main {
|
||||
flex: 1;
|
||||
overflow: auto;
|
||||
padding: 1.5rem;
|
||||
}
|
||||
|
||||
.report-info {
|
||||
margin-bottom: 1.5rem;
|
||||
padding: 1rem;
|
||||
background-color: var(--secondary-color);
|
||||
border-radius: var(--radius);
|
||||
border: 1px solid var(--border-color);
|
||||
}
|
||||
|
||||
.report-date {
|
||||
font-size: 0.875rem;
|
||||
color: var(--text-light);
|
||||
}
|
||||
|
||||
.report-stats {
|
||||
display: flex;
|
||||
gap: 1.5rem;
|
||||
margin-top: 1rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.stat-item {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.25rem;
|
||||
}
|
||||
|
||||
.stat-value {
|
||||
font-size: 1.25rem;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.stat-label {
|
||||
font-size: 0.875rem;
|
||||
color: var(--text-light);
|
||||
}
|
||||
|
||||
.table-wrapper {
|
||||
overflow-x: auto;
|
||||
border: 1px solid var(--border-color);
|
||||
border-radius: var(--radius);
|
||||
}
|
||||
|
||||
.findings-table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
font-size: 0.875rem;
|
||||
}
|
||||
|
||||
.findings-table th {
|
||||
background-color: var(--secondary-color);
|
||||
padding: 0.75rem;
|
||||
text-align: left;
|
||||
font-weight: 500;
|
||||
position: sticky;
|
||||
top: 0;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
/* Ensure table cells don't expand too much */
|
||||
.findings-table td {
|
||||
padding: 0.75rem;
|
||||
border-top: 1px solid var(--border-color);
|
||||
vertical-align: top;
|
||||
max-width: 300px; /* Limit width of all cells */
|
||||
overflow-wrap: break-word;
|
||||
}
|
||||
|
||||
.findings-table tr:hover td {
|
||||
background-color: var(--secondary-color);
|
||||
}
|
||||
|
||||
.findings-table th:nth-child(1) { width: 12%; } /* Rule */
|
||||
.findings-table th:nth-child(2) { width: 20%; } /* File */
|
||||
.findings-table th:nth-child(3) { width: 25%; } /* Description */
|
||||
.findings-table th:nth-child(4) { width: 20%; } /* Secret */
|
||||
.findings-table th:nth-child(5) { width: 23%; } /* Metadata */
|
||||
|
||||
.findings-table td {
|
||||
padding: 0.75rem;
|
||||
border-top: 1px solid var(--border-color);
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
.findings-table tr:hover td {
|
||||
background-color: var(--secondary-color);
|
||||
}
|
||||
|
||||
.secret-container {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.match-toggle {
|
||||
display: inline-block;
|
||||
margin-top: 0.5rem;
|
||||
padding: 0.25rem 0.5rem;
|
||||
background-color: var(--secondary-color);
|
||||
border: 1px solid var(--border-color);
|
||||
border-radius: var(--radius);
|
||||
font-size: 0.75rem;
|
||||
cursor: pointer;
|
||||
color: var(--primary-color);
|
||||
}
|
||||
|
||||
.match-toggle:hover {
|
||||
background-color: var(--primary-color);
|
||||
color: var(--text-inverse);
|
||||
}
|
||||
|
||||
.hidden {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
.secret-match {
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
word-break: break-all;
|
||||
white-space: pre-wrap;
|
||||
display: block;
|
||||
background-color: var(--highlight-secret);
|
||||
padding: 0.5rem;
|
||||
border-radius: var(--radius);
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.tag-list {
|
||||
display: flex;
|
||||
gap: 0.25rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.tag {
|
||||
display: inline-block;
|
||||
padding: 0.125rem 0.375rem;
|
||||
background-color: var(--primary-light);
|
||||
color: var(--text-inverse);
|
||||
border-radius: 2px;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.meta-row {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));
|
||||
gap: 0.5rem;
|
||||
margin-top: 0.5rem;
|
||||
font-size: 0.75rem;
|
||||
color: var(--text-light);
|
||||
}
|
||||
|
||||
.meta-item {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.25rem;
|
||||
}
|
||||
|
||||
.meta-label {
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.meta-value {
|
||||
font-family: var(--font-mono);
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
.code-preview {
|
||||
position: relative;
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
background-color: var(--secondary-color);
|
||||
padding: 0.5rem;
|
||||
border-radius: var(--radius);
|
||||
overflow-x: auto;
|
||||
margin-top: 0.5rem;
|
||||
white-space: pre-wrap;
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
.filters {
|
||||
display: flex;
|
||||
gap: 1rem;
|
||||
margin-bottom: 1rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.filter-group {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.filter-label {
|
||||
font-size: 0.875rem;
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.filter-input {
|
||||
padding: 0.375rem 0.75rem;
|
||||
border: 1px solid var(--border-color);
|
||||
border-radius: var(--radius);
|
||||
font-size: 0.875rem;
|
||||
font-family: var(--font-main);
|
||||
}
|
||||
|
||||
.app-footer {
|
||||
height: 40px;
|
||||
padding: 0 1.5rem;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
border-top: 1px solid var(--border-color);
|
||||
font-size: 0.75rem;
|
||||
color: var(--text-light);
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
.app-header {
|
||||
padding: 0 1rem;
|
||||
}
|
||||
|
||||
.app-main {
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
.report-stats {
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.filters {
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.app-footer {
|
||||
flex-direction: column;
|
||||
height: auto;
|
||||
padding: 0.75rem 1rem;
|
||||
gap: 0.5rem;
|
||||
justify-content: center;
|
||||
text-align: center;
|
||||
}
|
||||
}
|
||||
|
||||
.description-toggle {
|
||||
cursor: pointer;
|
||||
color: var(--primary-color);
|
||||
font-size: 0.875rem;
|
||||
margin-left: 0.5rem;
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 20px;
|
||||
height: 20px;
|
||||
border-radius: 50%;
|
||||
background-color: var(--secondary-color);
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
.description-toggle:hover {
|
||||
background-color: var(--primary-light);
|
||||
color: var(--text-inverse);
|
||||
}
|
||||
|
||||
.description-expanded {
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
.description-collapsed {
|
||||
white-space: nowrap;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
max-width: 250px;
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.commit-link {
|
||||
color: var(--primary-color);
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.commit-link:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
/* File path styling */
|
||||
.file-path-container {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.file-path {
|
||||
display: inline-block;
|
||||
max-width: 100%;
|
||||
word-wrap: break-word;
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
.match-content {
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
word-break: break-all;
|
||||
white-space: pre-wrap;
|
||||
display: block;
|
||||
background-color: var(--secondary-color);
|
||||
padding: 0.5rem;
|
||||
border-radius: var(--radius);
|
||||
margin-top: 0.5rem;
|
||||
max-height: 300px;
|
||||
overflow-y: auto;
|
||||
}
|
||||
|
||||
.dark-mode-toggle {
|
||||
background: none;
|
||||
border: none;
|
||||
color: var(--text-inverse);
|
||||
cursor: pointer;
|
||||
font-size: 1rem;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="app-container">
|
||||
<header class="app-header">
|
||||
<div class="logo">
|
||||
<h1>Gitleaks Security Findings</h1>
|
||||
</div>
|
||||
<div class="header-actions">
|
||||
<button class="dark-mode-toggle" id="darkModeToggle">🌓</button>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<main class="app-main">
|
||||
<div class="report-info">
|
||||
<h2>Security Scan Report</h2>
|
||||
<p class="report-date">Generated on {{now | date "Jan 02, 2006 15:04:05 MST"}}</p>
|
||||
|
||||
<div class="report-stats">
|
||||
<div class="stat-item">
|
||||
<span class="stat-value">{{len .}}</span>
|
||||
<span class="stat-label">Total Findings</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item">
|
||||
<span class="stat-value" id="filesCount">-</span>
|
||||
<span class="stat-label">Files Affected</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item">
|
||||
<span class="stat-value" id="rulesCount">-</span>
|
||||
<span class="stat-label">Unique Rules Triggered</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item" id="scanModeContainer">
|
||||
<span class="stat-value" id="scanMode">-</span>
|
||||
<span class="stat-label">Scan Mode</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="filters">
|
||||
<div class="filter-group">
|
||||
<label class="filter-label" for="filterRule">Filter by Rule:</label>
|
||||
<select class="filter-input" id="filterRule">
|
||||
<option value="all">All Rules</option>
|
||||
<!-- Rule options will be populated by JavaScript -->
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div class="filter-group">
|
||||
<label class="filter-label" for="filterFile">Filter by File:</label>
|
||||
<input type="text" class="filter-input" id="filterFile" placeholder="Enter filename...">
|
||||
</div>
|
||||
|
||||
<div class="filter-group">
|
||||
<button class="btn btn-primary btn-sm" id="resetFilters">Reset Filters</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="table-wrapper">
|
||||
<table class="findings-table" id="findingsTable">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Rule</th>
|
||||
<th>File</th>
|
||||
<th>Description</th>
|
||||
<th>Secret</th>
|
||||
<th>Metadata</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{{- range . }}
|
||||
<tr data-rule="{{.RuleID}}" data-file="{{.File}}">
|
||||
<td>{{.RuleID}}</td>
|
||||
<td>
|
||||
<div class="file-path-container">
|
||||
<span class="file-path" title="{{.File}}">{{.File}}</span>
|
||||
</div>
|
||||
<div class="tag-list">
|
||||
{{- range .Tags }}
|
||||
<span class="tag">{{.}}</span>
|
||||
{{- end}}
|
||||
</div>
|
||||
<div class="meta-row">
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Line:</span>
|
||||
<span class="meta-value">{{.StartLine}}</span>
|
||||
</div>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<span class="description-text">{{.Description}}</span>
|
||||
<span class="description-toggle" title="Expand/Collapse">↕</span>
|
||||
</td>
|
||||
<td>
|
||||
<div class="secret-container" data-secret="{{.Secret}}" data-match="{{.Match}}">
|
||||
<div class="secret-match">{{.Secret}}</div>
|
||||
<button type="button" class="match-toggle" title="Show/Hide Full Match Context">Show Context</button>
|
||||
<div class="match-content hidden" data-raw-match="{{.Match}}">{{.Match}}</div>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<div class="meta-row">
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Entropy:</span>
|
||||
<span class="meta-value">{{printf "%.2f" .Entropy}}</span>
|
||||
</div>
|
||||
{{- if .Commit}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Commit:</span>
|
||||
<span class="meta-value">{{if gt (len .Commit) 7}}{{printf "%.7s" .Commit}}{{else}}{{.Commit}}{{end}}</span>
|
||||
</div>
|
||||
{{- if .Author}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Author:</span>
|
||||
<span class="meta-value">{{.Author}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- if .Date}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Date:</span>
|
||||
<span class="meta-value">{{.Date}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- if .Link}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Link:</span>
|
||||
<span class="meta-value"><a href="{{.Link}}" target="_blank" class="commit-link">View Commit</a></span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- else}}
|
||||
{{- if .Author}}
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Author:</span>
|
||||
<span class="meta-value">{{.Author}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- end}}
|
||||
</div>
|
||||
|
||||
{{- if not .Match}}
|
||||
<div class="match-content" data-raw-match="">-</div>
|
||||
{{- end}}
|
||||
</td>
|
||||
</tr>
|
||||
{{- end }}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<footer class="app-footer">
|
||||
<div>Generated by Gitleaks</div>
|
||||
<div>Total Findings: <strong>{{len .}}</strong></div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
// Process data to collect unique files and rules
|
||||
function processData() {
|
||||
const rows = document.querySelectorAll('#findingsTable tbody tr');
|
||||
const uniqueRules = new Set();
|
||||
const uniqueFiles = new Set();
|
||||
let isGitMode = false;
|
||||
|
||||
if (rows.length > 0) {
|
||||
// Check if first finding has commit data to determine mode
|
||||
const firstRow = rows[0];
|
||||
const commitCells = firstRow.querySelectorAll('.commit-info');
|
||||
isGitMode = commitCells.length > 0 && commitCells[0].textContent.trim() !== '';
|
||||
}
|
||||
|
||||
// Set scan mode
|
||||
document.getElementById('scanMode').textContent = isGitMode ? 'Git' : 'Directory';
|
||||
|
||||
// Adjust UI based on mode
|
||||
if (isGitMode) {
|
||||
// Ensure commit info columns are visible for git mode
|
||||
document.querySelectorAll('.commit-info').forEach(el => {
|
||||
el.style.display = 'block';
|
||||
});
|
||||
} else {
|
||||
// Hide commit-specific UI elements for directory mode
|
||||
document.querySelectorAll('.commit-info').forEach(el => {
|
||||
el.style.display = 'none';
|
||||
});
|
||||
}
|
||||
|
||||
rows.forEach(row => {
|
||||
uniqueRules.add(row.dataset.rule);
|
||||
uniqueFiles.add(row.dataset.file);
|
||||
});
|
||||
|
||||
// Update stats
|
||||
document.getElementById('filesCount').textContent = uniqueFiles.size;
|
||||
document.getElementById('rulesCount').textContent = uniqueRules.size;
|
||||
|
||||
// Populate rule filter dropdown
|
||||
const ruleFilter = document.getElementById('filterRule');
|
||||
const sortedRules = Array.from(uniqueRules).sort();
|
||||
sortedRules.forEach(rule => {
|
||||
const option = document.createElement('option');
|
||||
option.value = rule;
|
||||
option.textContent = rule;
|
||||
ruleFilter.appendChild(option);
|
||||
});
|
||||
}
|
||||
|
||||
// Hide toggle button if match is same as secret
|
||||
function hideRedundantToggleButtons() {
|
||||
document.querySelectorAll('.secret-container').forEach(container => {
|
||||
const secret = container.getAttribute('data-secret');
|
||||
const match = container.getAttribute('data-match');
|
||||
const toggleButton = container.querySelector('.match-toggle');
|
||||
|
||||
// If secret and match are the same, or if match is empty, hide the toggle button
|
||||
if ((secret && match && secret.trim() === match.trim()) || !match) {
|
||||
if (toggleButton) {
|
||||
toggleButton.style.display = 'none';
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Setup toggle buttons
|
||||
function setupToggleButtons() {
|
||||
document.querySelectorAll('.match-toggle').forEach(btn => {
|
||||
btn.addEventListener('click', function() {
|
||||
const matchContent = this.nextElementSibling;
|
||||
if (matchContent.classList.contains('hidden')) {
|
||||
matchContent.classList.remove('hidden');
|
||||
this.textContent = 'Hide Context';
|
||||
} else {
|
||||
matchContent.classList.add('hidden');
|
||||
this.textContent = 'Show Context';
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Setup description toggle
|
||||
document.querySelectorAll('.description-text').forEach(descriptionText => {
|
||||
const toggleBtn = descriptionText.nextElementSibling;
|
||||
if (!toggleBtn || !toggleBtn.classList.contains('description-toggle')) return;
|
||||
|
||||
// Initial state: collapsed
|
||||
descriptionText.classList.add('description-collapsed');
|
||||
|
||||
toggleBtn.addEventListener('click', () => {
|
||||
if (descriptionText.classList.contains('description-collapsed')) {
|
||||
descriptionText.classList.remove('description-collapsed');
|
||||
descriptionText.classList.add('description-expanded');
|
||||
toggleBtn.textContent = '↑';
|
||||
} else {
|
||||
descriptionText.classList.remove('description-expanded');
|
||||
descriptionText.classList.add('description-collapsed');
|
||||
toggleBtn.textContent = '↕';
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// Initialize dark mode from user preference
|
||||
function initDarkMode() {
|
||||
const prefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
|
||||
const storedPreference = localStorage.getItem('darkMode');
|
||||
|
||||
if (storedPreference === 'true' || (storedPreference === null && prefersDark)) {
|
||||
document.body.classList.add('dark-mode');
|
||||
}
|
||||
}
|
||||
|
||||
// Toggle dark mode
|
||||
document.getElementById('darkModeToggle').addEventListener('click', function() {
|
||||
document.body.classList.toggle('dark-mode');
|
||||
localStorage.setItem('darkMode', document.body.classList.contains('dark-mode'));
|
||||
});
|
||||
|
||||
// Filter functionality
|
||||
function applyFilters() {
|
||||
const ruleFilter = document.getElementById('filterRule').value;
|
||||
const fileFilter = document.getElementById('filterFile').value.toLowerCase();
|
||||
|
||||
const rows = document.querySelectorAll('#findingsTable tbody tr');
|
||||
|
||||
rows.forEach(row => {
|
||||
const ruleMatch = ruleFilter === 'all' || row.dataset.rule === ruleFilter;
|
||||
const fileMatch = fileFilter === '' || row.dataset.file.toLowerCase().includes(fileFilter);
|
||||
|
||||
if (ruleMatch && fileMatch) {
|
||||
row.style.display = '';
|
||||
} else {
|
||||
row.style.display = 'none';
|
||||
}
|
||||
});
|
||||
|
||||
// Update visible count
|
||||
const visibleFindings = document.querySelectorAll('#findingsTable tbody tr:not([style*="display: none"])').length;
|
||||
document.querySelector('.app-footer strong').textContent = visibleFindings;
|
||||
}
|
||||
|
||||
document.getElementById('filterRule').addEventListener('change', applyFilters);
|
||||
document.getElementById('filterFile').addEventListener('input', applyFilters);
|
||||
document.getElementById('resetFilters').addEventListener('click', function() {
|
||||
document.getElementById('filterRule').value = 'all';
|
||||
document.getElementById('filterFile').value = '';
|
||||
applyFilters();
|
||||
});
|
||||
|
||||
// Initialize
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
processData();
|
||||
hideRedundantToggleButtons(); // Hide toggle buttons for matching secrets
|
||||
setupToggleButtons();
|
||||
initDarkMode();
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
847
templates/leet.tmpl
Normal file
847
templates/leet.tmpl
Normal file
@ -0,0 +1,847 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Gitleaks Security Findings Report</title>
|
||||
<style>
|
||||
:root {
|
||||
--primary-color: #00ff00;
|
||||
--primary-color-rgb: 0, 255, 0;
|
||||
--primary-dark: #00cc00;
|
||||
--primary-light: #66ff66;
|
||||
--secondary-color: #111111;
|
||||
--surface-color: #000000;
|
||||
--border-color: #00ff00;
|
||||
--text-color: #00ff00;
|
||||
--text-light: #00cc00;
|
||||
--text-inverse: #000000;
|
||||
--error-color: #ff0000;
|
||||
--warning-color: #ffff00;
|
||||
--success-color: #00ff00;
|
||||
--highlight-color: rgba(0, 255, 0, 0.2);
|
||||
--highlight-secret: rgba(255, 0, 0, 0.2);
|
||||
--shadow: 0 0 10px rgba(0, 255, 0, 0.8);
|
||||
--radius: 0;
|
||||
--font-mono: 'Courier New', monospace;
|
||||
--font-main: 'Courier New', monospace;
|
||||
}
|
||||
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
html, body {
|
||||
height: 100%;
|
||||
font-family: var(--font-main);
|
||||
font-size: 16px;
|
||||
line-height: 1.5;
|
||||
color: var(--text-color);
|
||||
background-color: #000000;
|
||||
background-image: url("data:image/svg+xml,%3Csvg width='40' height='40' viewBox='0 0 40 40' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M0 0h40v40H0V0zm20 10a10 10 0 1 1 0 20 10 10 0 0 1 0-20zm0 5a5 5 0 1 0 0 10 5 5 0 0 0 0-10z' fill='%23003300' fill-opacity='0.5' fill-rule='evenodd'/%3E%3C/svg%3E");
|
||||
}
|
||||
|
||||
.app-container {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
height: 100%;
|
||||
max-width: 100%;
|
||||
overflow: hidden;
|
||||
border: 1px solid #00ff00;
|
||||
box-shadow: 0 0 20px rgba(0, 255, 0, 0.5);
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.app-container::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
height: 5px;
|
||||
background: repeating-linear-gradient(
|
||||
90deg,
|
||||
#00ff00,
|
||||
#00ff00 10px,
|
||||
#000000 10px,
|
||||
#000000 20px
|
||||
);
|
||||
z-index: 10;
|
||||
}
|
||||
|
||||
.app-container::after {
|
||||
content: "";
|
||||
position: absolute;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
height: 5px;
|
||||
background: repeating-linear-gradient(
|
||||
90deg,
|
||||
#00ff00,
|
||||
#00ff00 10px,
|
||||
#000000 10px,
|
||||
#000000 20px
|
||||
);
|
||||
z-index: 10;
|
||||
}
|
||||
|
||||
.app-header {
|
||||
background-color: #111111;
|
||||
border-bottom: 1px solid #00ff00;
|
||||
height: auto;
|
||||
padding: 10px 15px;
|
||||
position: relative;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
flex-shrink: 0;
|
||||
box-shadow: var(--shadow);
|
||||
z-index: 10;
|
||||
}
|
||||
|
||||
.logo h1 {
|
||||
font-size: 20px;
|
||||
font-weight: bold;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 2px;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
text-shadow: 0 0 5px #00ff00;
|
||||
}
|
||||
|
||||
.logo h1::before {
|
||||
content: "[ ";
|
||||
}
|
||||
|
||||
.logo h1::after {
|
||||
content: " ]_";
|
||||
animation: blink 1s step-end infinite;
|
||||
}
|
||||
|
||||
@keyframes blink {
|
||||
0%, 100% { opacity: 1; }
|
||||
50% { opacity: 0; }
|
||||
}
|
||||
|
||||
.btn {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
background-color: #000000;
|
||||
color: #00ff00;
|
||||
border: 1px solid #00ff00;
|
||||
font-family: 'Courier New', monospace;
|
||||
text-transform: lowercase;
|
||||
letter-spacing: 1px;
|
||||
transition: all 0.2s;
|
||||
font-size: 0.875rem;
|
||||
font-weight: 500;
|
||||
cursor: pointer;
|
||||
padding: 0.5rem 1rem;
|
||||
}
|
||||
|
||||
.btn::before {
|
||||
content: "[ ";
|
||||
}
|
||||
|
||||
.btn::after {
|
||||
content: " ]";
|
||||
}
|
||||
|
||||
.btn:hover {
|
||||
background-color: #00ff00;
|
||||
color: #000000;
|
||||
box-shadow: 0 0 10px #00ff00;
|
||||
}
|
||||
|
||||
.btn-primary {
|
||||
background-color: #000000;
|
||||
color: #00ff00;
|
||||
}
|
||||
|
||||
.btn-primary:hover {
|
||||
background-color: #00ff00;
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
.btn-sm {
|
||||
padding: 0.25rem 0.5rem;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.app-main {
|
||||
flex: 1;
|
||||
overflow: auto;
|
||||
padding: 1.5rem;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.report-info {
|
||||
background-color: #111111;
|
||||
border: 1px solid #00ff00;
|
||||
padding: 15px;
|
||||
margin-bottom: 20px;
|
||||
position: relative;
|
||||
box-shadow: 0 0 10px rgba(0, 255, 0, 0.3);
|
||||
}
|
||||
|
||||
.report-info h2 {
|
||||
color: #00ff00;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 1px;
|
||||
margin-top: 0;
|
||||
text-shadow: 0 0 5px #00ff00;
|
||||
}
|
||||
|
||||
.report-info h2::before {
|
||||
content: "//";
|
||||
margin-right: 10px;
|
||||
}
|
||||
|
||||
.report-date {
|
||||
color: #00cc00;
|
||||
font-style: italic;
|
||||
font-size: 0.875rem;
|
||||
}
|
||||
|
||||
.report-stats {
|
||||
display: flex;
|
||||
gap: 1.5rem;
|
||||
margin-top: 1rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.stat-item {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.25rem;
|
||||
}
|
||||
|
||||
.stat-value {
|
||||
color: #00ff00;
|
||||
font-weight: bold;
|
||||
text-shadow: 0 0 5px #00ff00;
|
||||
font-size: 1.25rem;
|
||||
}
|
||||
|
||||
.stat-label {
|
||||
text-transform: uppercase;
|
||||
font-size: 10px;
|
||||
letter-spacing: 1px;
|
||||
color: var(--text-light);
|
||||
}
|
||||
|
||||
.table-wrapper {
|
||||
overflow-x: auto;
|
||||
border: 1px solid #00ff00;
|
||||
box-shadow: 0 0 10px rgba(0, 255, 0, 0.3);
|
||||
}
|
||||
|
||||
.findings-table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
font-size: 0.875rem;
|
||||
}
|
||||
|
||||
.findings-table th {
|
||||
background-color: #111111;
|
||||
color: #00ff00;
|
||||
font-weight: bold;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 1px;
|
||||
padding: 10px;
|
||||
border: 1px solid #004400;
|
||||
position: sticky;
|
||||
top: 0;
|
||||
z-index: 1;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.findings-table td {
|
||||
background-color: #000000;
|
||||
border: 1px solid #004400;
|
||||
padding: 10px;
|
||||
font-size: 13px;
|
||||
vertical-align: top;
|
||||
max-width: 300px; /* Limit width of all cells */
|
||||
overflow-wrap: break-word;
|
||||
}
|
||||
|
||||
.findings-table tr:hover td {
|
||||
background-color: #001100;
|
||||
}
|
||||
|
||||
.findings-table th:nth-child(1) { width: 12%; } /* Rule */
|
||||
.findings-table th:nth-child(2) { width: 20%; } /* File */
|
||||
.findings-table th:nth-child(3) { width: 25%; } /* Description */
|
||||
.findings-table th:nth-child(4) { width: 20%; } /* Secret */
|
||||
.findings-table th:nth-child(5) { width: 23%; } /* Metadata */
|
||||
|
||||
.filters {
|
||||
background-color: #111111;
|
||||
padding: 15px;
|
||||
border: 1px solid #00ff00;
|
||||
margin-bottom: 20px;
|
||||
box-shadow: 0 0 10px rgba(0, 255, 0, 0.3);
|
||||
display: flex;
|
||||
gap: 1rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.filter-group {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.filter-label {
|
||||
color: #00ff00;
|
||||
font-weight: bold;
|
||||
text-transform: uppercase;
|
||||
font-size: 12px;
|
||||
letter-spacing: 1px;
|
||||
}
|
||||
|
||||
.filter-input {
|
||||
background-color: #000000;
|
||||
border: 1px solid #00ff00;
|
||||
color: #00ff00;
|
||||
padding: 8px 10px;
|
||||
font-family: 'Courier New', monospace;
|
||||
font-size: 0.875rem;
|
||||
}
|
||||
|
||||
.filter-input:focus {
|
||||
outline: none;
|
||||
box-shadow: 0 0 10px #00ff00;
|
||||
}
|
||||
|
||||
.secret-container {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.match-toggle {
|
||||
display: inline-block;
|
||||
margin-top: 0.5rem;
|
||||
background-color: #000000;
|
||||
color: #00ff00;
|
||||
border: 1px solid #00ff00;
|
||||
font-family: 'Courier New', monospace;
|
||||
text-transform: lowercase;
|
||||
font-size: 11px;
|
||||
letter-spacing: 1px;
|
||||
transition: all 0.2s;
|
||||
cursor: pointer;
|
||||
padding: 0.25rem 0.5rem;
|
||||
}
|
||||
|
||||
.match-toggle:hover {
|
||||
background-color: #00ff00;
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
.hidden {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
.secret-match {
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
word-break: break-all;
|
||||
white-space: pre-wrap;
|
||||
display: block;
|
||||
background-color: #110000;
|
||||
border: 1px solid #ff0000;
|
||||
color: #ff0000;
|
||||
font-weight: bold;
|
||||
padding: 8px;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.tag-list {
|
||||
display: flex;
|
||||
gap: 0.25rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.tag {
|
||||
display: inline-block;
|
||||
background-color: #001100;
|
||||
color: #00ff00;
|
||||
border: 1px solid #00ff00;
|
||||
text-transform: lowercase;
|
||||
font-size: 10px;
|
||||
letter-spacing: 1px;
|
||||
padding: 2px 5px;
|
||||
}
|
||||
|
||||
.meta-row {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));
|
||||
gap: 0.5rem;
|
||||
margin-top: 0.5rem;
|
||||
font-size: 0.75rem;
|
||||
color: var(--text-light);
|
||||
}
|
||||
|
||||
.meta-item {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.25rem;
|
||||
}
|
||||
|
||||
.meta-label {
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.meta-value {
|
||||
font-family: var(--font-mono);
|
||||
word-break: break-all;
|
||||
color: #00ffff;
|
||||
}
|
||||
|
||||
.description-toggle {
|
||||
cursor: pointer;
|
||||
color: #00ff00;
|
||||
font-size: 0.875rem;
|
||||
margin-left: 0.5rem;
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 20px;
|
||||
height: 20px;
|
||||
background-color: #000000;
|
||||
border: 1px solid #00ff00;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
.description-toggle:hover {
|
||||
background-color: #00ff00;
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
.description-expanded {
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
.description-collapsed {
|
||||
white-space: nowrap;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
max-width: 250px;
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.commit-link {
|
||||
color: #00ffff;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.commit-link:hover {
|
||||
text-decoration: none;
|
||||
text-shadow: 0 0 5px #00ffff;
|
||||
}
|
||||
|
||||
/* File path styling */
|
||||
.file-path-container {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.file-path {
|
||||
display: inline-block;
|
||||
max-width: 100%;
|
||||
word-wrap: break-word;
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
.match-content {
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
word-break: break-all;
|
||||
white-space: pre-wrap;
|
||||
display: block;
|
||||
background-color: #001100;
|
||||
border: 1px solid #00ff00;
|
||||
padding: 8px;
|
||||
color: #00ff00;
|
||||
margin-top: 0.5rem;
|
||||
max-height: 300px;
|
||||
overflow-y: auto;
|
||||
}
|
||||
|
||||
.app-footer {
|
||||
background-color: #111111;
|
||||
color: #00ff00;
|
||||
border-top: 1px solid #00ff00;
|
||||
padding: 10px 15px;
|
||||
font-size: 12px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
/* Random binary background */
|
||||
.app-main::before {
|
||||
content: "";
|
||||
position: fixed;
|
||||
top: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
background-color: rgba(0, 0, 0, 0.9);
|
||||
background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='200' height='200' viewBox='0 0 200 200'%3E%3Cg fill='%23003300' fill-opacity='0.1'%3E%3Ctext x='0' y='10' font-family='monospace' font-size='10'%3E01001010111001010101%3C/text%3E%3Ctext x='0' y='20' font-family='monospace' font-size='10'%3E10010111001010101010%3C/text%3E%3Ctext x='0' y='30' font-family='monospace' font-size='10'%3E01011100101010101001%3C/text%3E%3Ctext x='0' y='40' font-family='monospace' font-size='10'%3E10110010101010100101%3C/text%3E%3Ctext x='0' y='50' font-family='monospace' font-size='10'%3E01100101010101001011%3C/text%3E%3Ctext x='0' y='60' font-family='monospace' font-size='10'%3E11001010101010010110%3C/text%3E%3Ctext x='0' y='70' font-family='monospace' font-size='10'%3E10010101010100101100%3C/text%3E%3Ctext x='0' y='80' font-family='monospace' font-size='10'%3E00101010101001011001%3C/text%3E%3Ctext x='0' y='90' font-family='monospace' font-size='10'%3E01010101010010110010%3C/text%3E%3Ctext x='0' y='100' font-family='monospace' font-size='10'%3E10101010100101100101%3C/text%3E%3Ctext x='0' y='110' font-family='monospace' font-size='10'%3E01010101001011001010%3C/text%3E%3Ctext x='0' y='120' font-family='monospace' font-size='10'%3E10101010010110010101%3C/text%3E%3Ctext x='0' y='130' font-family='monospace' font-size='10'%3E01010100101100101010%3C/text%3E%3Ctext x='0' y='140' font-family='monospace' font-size='10'%3E10101001011001010101%3C/text%3E%3Ctext x='0' y='150' font-family='monospace' font-size='10'%3E01010010110010101010%3C/text%3E%3Ctext x='0' y='160' font-family='monospace' font-size='10'%3E10100101100101010101%3C/text%3E%3Ctext x='0' y='170' font-family='monospace' font-size='10'%3E01001011001010101010%3C/text%3E%3Ctext x='0' y='180' font-family='monospace' font-size='10'%3E10010110010101010101%3C/text%3E%3Ctext x='0' y='190' font-family='monospace' font-size='10'%3E00101100101010101010%3C/text%3E%3Ctext x='0' y='200' font-family='monospace' font-size='10'%3E01011001010101010101%3C/text%3E%3C/g%3E%3C/svg%3E");
|
||||
pointer-events: none;
|
||||
opacity: 0.3;
|
||||
z-index: -1;
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
.app-header {
|
||||
padding: 8px 10px;
|
||||
}
|
||||
|
||||
.app-main {
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
.report-stats {
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.filters {
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.app-footer {
|
||||
flex-direction: column;
|
||||
height: auto;
|
||||
padding: 0.75rem 1rem;
|
||||
gap: 0.5rem;
|
||||
justify-content: center;
|
||||
text-align: center;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="app-container">
|
||||
<header class="app-header">
|
||||
<div class="logo">
|
||||
<h1>Gitleaks Security Findings</h1>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<main class="app-main">
|
||||
<div class="report-info">
|
||||
<h2>Security Scan Report</h2>
|
||||
<p class="report-date">Generated on {{now | date "Jan 02, 2006 15:04:05 MST"}}</p>
|
||||
|
||||
<div class="report-stats">
|
||||
<div class="stat-item">
|
||||
<span class="stat-value">{{len .}}</span>
|
||||
<span class="stat-label">Total Findings</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item">
|
||||
<span class="stat-value" id="filesCount">-</span>
|
||||
<span class="stat-label">Files Affected</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item">
|
||||
<span class="stat-value" id="rulesCount">-</span>
|
||||
<span class="stat-label">Unique Rules Triggered</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item" id="scanModeContainer">
|
||||
<span class="stat-value" id="scanMode">-</span>
|
||||
<span class="stat-label">Scan Mode</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="filters">
|
||||
<div class="filter-group">
|
||||
<label class="filter-label" for="filterRule">Filter by Rule:</label>
|
||||
<select class="filter-input" id="filterRule">
|
||||
<option value="all">All Rules</option>
|
||||
<!-- Rule options will be populated by JavaScript -->
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div class="filter-group">
|
||||
<label class="filter-label" for="filterFile">Filter by File:</label>
|
||||
<input type="text" class="filter-input" id="filterFile" placeholder="Enter filename...">
|
||||
</div>
|
||||
|
||||
<div class="filter-group">
|
||||
<button class="btn btn-primary btn-sm" id="resetFilters">Reset Filters</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="table-wrapper">
|
||||
<table class="findings-table" id="findingsTable">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Rule</th>
|
||||
<th>File</th>
|
||||
<th>Description</th>
|
||||
<th>Secret</th>
|
||||
<th>Metadata</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{{- range . }}
|
||||
<tr data-rule="{{.RuleID}}" data-file="{{.File}}">
|
||||
<td>{{.RuleID}}</td>
|
||||
<td>
|
||||
<div class="file-path-container">
|
||||
<span class="file-path" title="{{.File}}">{{.File}}</span>
|
||||
</div>
|
||||
<div class="tag-list">
|
||||
{{- range .Tags }}
|
||||
<span class="tag">{{.}}</span>
|
||||
{{- end}}
|
||||
</div>
|
||||
<div class="meta-row">
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Line:</span>
|
||||
<span class="meta-value">{{.StartLine}}</span>
|
||||
</div>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<span class="description-text">{{.Description}}</span>
|
||||
<span class="description-toggle" title="Expand/Collapse">↕</span>
|
||||
</td>
|
||||
<td>
|
||||
<div class="secret-container" data-secret="{{.Secret}}" data-match="{{.Match}}">
|
||||
<div class="secret-match">{{.Secret}}</div>
|
||||
<button type="button" class="match-toggle" title="Show/Hide Full Match Context">Show Context</button>
|
||||
<div class="match-content hidden" data-raw-match="{{.Match}}">{{.Match}}</div>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<div class="meta-row">
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Entropy:</span>
|
||||
<span class="meta-value">{{printf "%.2f" .Entropy}}</span>
|
||||
</div>
|
||||
{{- if .Commit}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Commit:</span>
|
||||
<span class="meta-value">{{if gt (len .Commit) 7}}{{printf "%.7s" .Commit}}{{else}}{{.Commit}}{{end}}</span>
|
||||
</div>
|
||||
{{- if .Author}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Author:</span>
|
||||
<span class="meta-value">{{.Author}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- if .Date}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Date:</span>
|
||||
<span class="meta-value">{{.Date}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- if .Link}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Link:</span>
|
||||
<span class="meta-value"><a href="{{.Link}}" target="_blank" class="commit-link">View Commit</a></span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- else}}
|
||||
{{- if .Author}}
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Author:</span>
|
||||
<span class="meta-value">{{.Author}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- end}}
|
||||
</div>
|
||||
|
||||
{{- if not .Match}}
|
||||
<div class="match-content" data-raw-match="">-</div>
|
||||
{{- end}}
|
||||
</td>
|
||||
</tr>
|
||||
{{- end }}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<footer class="app-footer">
|
||||
<div>Generated by Gitleaks</div>
|
||||
<div>Total Findings: <strong>{{len .}}</strong></div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
// Process data to collect unique files and rules
|
||||
function processData() {
|
||||
const rows = document.querySelectorAll('#findingsTable tbody tr');
|
||||
const uniqueRules = new Set();
|
||||
const uniqueFiles = new Set();
|
||||
let isGitMode = false;
|
||||
|
||||
if (rows.length > 0) {
|
||||
// Check if first finding has commit data to determine mode
|
||||
const firstRow = rows[0];
|
||||
const commitCells = firstRow.querySelectorAll('.commit-info');
|
||||
isGitMode = commitCells.length > 0 && commitCells[0].textContent.trim() !== '';
|
||||
}
|
||||
|
||||
// Set scan mode
|
||||
document.getElementById('scanMode').textContent = isGitMode ? 'Git' : 'Directory';
|
||||
|
||||
// Adjust UI based on mode
|
||||
if (isGitMode) {
|
||||
// Ensure commit info columns are visible for git mode
|
||||
document.querySelectorAll('.commit-info').forEach(el => {
|
||||
el.style.display = 'block';
|
||||
});
|
||||
} else {
|
||||
// Hide commit-specific UI elements for directory mode
|
||||
document.querySelectorAll('.commit-info').forEach(el => {
|
||||
el.style.display = 'none';
|
||||
});
|
||||
}
|
||||
|
||||
rows.forEach(row => {
|
||||
uniqueRules.add(row.dataset.rule);
|
||||
uniqueFiles.add(row.dataset.file);
|
||||
});
|
||||
|
||||
// Update stats
|
||||
document.getElementById('filesCount').textContent = uniqueFiles.size;
|
||||
document.getElementById('rulesCount').textContent = uniqueRules.size;
|
||||
|
||||
// Populate rule filter dropdown
|
||||
const ruleFilter = document.getElementById('filterRule');
|
||||
const sortedRules = Array.from(uniqueRules).sort();
|
||||
sortedRules.forEach(rule => {
|
||||
const option = document.createElement('option');
|
||||
option.value = rule;
|
||||
option.textContent = rule;
|
||||
ruleFilter.appendChild(option);
|
||||
});
|
||||
}
|
||||
|
||||
// Hide toggle button if match is same as secret
|
||||
function hideRedundantToggleButtons() {
|
||||
document.querySelectorAll('.secret-container').forEach(container => {
|
||||
const secret = container.getAttribute('data-secret');
|
||||
const match = container.getAttribute('data-match');
|
||||
const toggleButton = container.querySelector('.match-toggle');
|
||||
|
||||
// If secret and match are the same, or if match is empty, hide the toggle button
|
||||
if ((secret && match && secret.trim() === match.trim()) || !match) {
|
||||
if (toggleButton) {
|
||||
toggleButton.style.display = 'none';
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Setup toggle buttons
|
||||
function setupToggleButtons() {
|
||||
document.querySelectorAll('.match-toggle').forEach(btn => {
|
||||
btn.addEventListener('click', function() {
|
||||
const matchContent = this.nextElementSibling;
|
||||
if (matchContent.classList.contains('hidden')) {
|
||||
matchContent.classList.remove('hidden');
|
||||
this.textContent = 'Hide Context';
|
||||
} else {
|
||||
matchContent.classList.add('hidden');
|
||||
this.textContent = 'Show Context';
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Setup description toggle
|
||||
document.querySelectorAll('.description-text').forEach(descriptionText => {
|
||||
const toggleBtn = descriptionText.nextElementSibling;
|
||||
if (!toggleBtn || !toggleBtn.classList.contains('description-toggle')) return;
|
||||
|
||||
// Initial state: collapsed
|
||||
descriptionText.classList.add('description-collapsed');
|
||||
|
||||
toggleBtn.addEventListener('click', () => {
|
||||
if (descriptionText.classList.contains('description-collapsed')) {
|
||||
descriptionText.classList.remove('description-collapsed');
|
||||
descriptionText.classList.add('description-expanded');
|
||||
toggleBtn.textContent = '↑';
|
||||
} else {
|
||||
descriptionText.classList.remove('description-expanded');
|
||||
descriptionText.classList.add('description-collapsed');
|
||||
toggleBtn.textContent = '↕';
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// Type effect for headers (optional)
|
||||
function typeEffect() {
|
||||
const headers = document.querySelectorAll('h2');
|
||||
headers.forEach(header => {
|
||||
const text = header.textContent;
|
||||
header.textContent = '';
|
||||
let i = 0;
|
||||
const interval = setInterval(() => {
|
||||
if (i < text.length) {
|
||||
header.textContent += text.charAt(i);
|
||||
i++;
|
||||
} else {
|
||||
clearInterval(interval);
|
||||
}
|
||||
}, 50);
|
||||
});
|
||||
}
|
||||
|
||||
// Filter functionality
|
||||
function applyFilters() {
|
||||
const ruleFilter = document.getElementById('filterRule').value;
|
||||
const fileFilter = document.getElementById('filterFile').value.toLowerCase();
|
||||
|
||||
const rows = document.querySelectorAll('#findingsTable tbody tr');
|
||||
|
||||
rows.forEach(row => {
|
||||
const ruleMatch = ruleFilter === 'all' || row.dataset.rule === ruleFilter;
|
||||
const fileMatch = fileFilter === '' || row.dataset.file.toLowerCase().includes(fileFilter);
|
||||
|
||||
if (ruleMatch && fileMatch) {
|
||||
row.style.display = '';
|
||||
} else {
|
||||
row.style.display = 'none';
|
||||
}
|
||||
});
|
||||
|
||||
// Update visible count
|
||||
const visibleFindings = document.querySelectorAll('#findingsTable tbody tr:not([style*="display: none"])').length;
|
||||
document.querySelector('.app-footer strong').textContent = visibleFindings;
|
||||
}
|
||||
|
||||
document.getElementById('filterRule').addEventListener('change', applyFilters);
|
||||
document.getElementById('filterFile').addEventListener('input', applyFilters);
|
||||
document.getElementById('resetFilters').addEventListener('click', function() {
|
||||
document.getElementById('filterRule').value = 'all';
|
||||
document.getElementById('filterFile').value = '';
|
||||
applyFilters();
|
||||
});
|
||||
|
||||
// Initialize
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
processData();
|
||||
hideRedundantToggleButtons(); // Hide toggle buttons for matching secrets
|
||||
setupToggleButtons();
|
||||
typeEffect(); // Add the typing effect
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
800
templates/myspace.tmpl
Normal file
800
templates/myspace.tmpl
Normal file
@ -0,0 +1,800 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Gitleaks Security Findings Report</title>
|
||||
<style>
|
||||
:root {
|
||||
--primary-color: #ff00ff;
|
||||
--primary-color-rgb: 255, 0, 255;
|
||||
--primary-dark: #cc00cc;
|
||||
--primary-light: #ff66ff;
|
||||
--secondary-color: #00ffff;
|
||||
--surface-color: #000000;
|
||||
--border-color: #00ffff;
|
||||
--text-color: #ffffff;
|
||||
--text-light: #00ffff;
|
||||
--text-inverse: #000000;
|
||||
--error-color: #ff0000;
|
||||
--warning-color: #ffff00;
|
||||
--success-color: #00ff00;
|
||||
--highlight-color: rgba(0, 255, 255, 0.3);
|
||||
--highlight-secret: rgba(255, 0, 255, 0.3);
|
||||
--shadow: 0 0 10px rgba(0, 255, 255, 0.8);
|
||||
--radius: 0;
|
||||
--font-mono: 'Courier New', monospace;
|
||||
--font-main: 'Comic Sans MS', 'Arial', sans-serif;
|
||||
}
|
||||
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
html, body {
|
||||
height: 100%;
|
||||
font-family: var(--font-main);
|
||||
font-size: 16px;
|
||||
line-height: 1.5;
|
||||
color: var(--text-color);
|
||||
background-color: #000000;
|
||||
background-image: url('https://cdnjs.cloudflare.com/ajax/libs/Animated_GIF/1.0.1/src/a_gif_star.gif');
|
||||
cursor: url('https://cdnjs.cloudflare.com/ajax/libs/Animated_GIF/1.0.1/src/a_gif_pointer.gif'), auto;
|
||||
}
|
||||
|
||||
.app-container {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
height: 100%;
|
||||
max-width: 100%;
|
||||
overflow: hidden;
|
||||
border: 3px outset #00ffff;
|
||||
box-shadow: 0 0 20px rgba(255, 0, 255, 0.5);
|
||||
}
|
||||
|
||||
.app-header {
|
||||
background: linear-gradient(to right, #ff00ff, #00ffff);
|
||||
background-size: 200% 100%;
|
||||
animation: rainbow 3s linear infinite;
|
||||
text-shadow: 0 0 5px #ffffff;
|
||||
height: auto;
|
||||
padding: 10px 15px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
flex-shrink: 0;
|
||||
box-shadow: var(--shadow);
|
||||
z-index: 10;
|
||||
color: var(--text-inverse);
|
||||
}
|
||||
|
||||
.logo h1 {
|
||||
animation: blink 1s step-end infinite;
|
||||
font-family: 'Comic Sans MS', cursive, sans-serif;
|
||||
font-size: 24px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.btn {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
background: linear-gradient(to bottom, #ff00ff, #00ffff);
|
||||
border: 3px outset #00ffff;
|
||||
text-shadow: 0 0 5px #000000;
|
||||
font-weight: bold;
|
||||
animation: pulse 2s infinite;
|
||||
font-size: 0.875rem;
|
||||
font-weight: 600;
|
||||
cursor: pointer;
|
||||
padding: 0.5rem 1rem;
|
||||
transition: all 0.2s;
|
||||
border-radius: var(--radius);
|
||||
font-family: var(--font-main);
|
||||
}
|
||||
|
||||
.btn:hover {
|
||||
transform: scale(1.1);
|
||||
box-shadow: 0 0 15px rgba(255, 0, 255, 0.8);
|
||||
}
|
||||
|
||||
.btn-primary {
|
||||
background: linear-gradient(to bottom, #ff00ff, #00ffff);
|
||||
color: white;
|
||||
}
|
||||
|
||||
.btn-sm {
|
||||
padding: 0.25rem 0.5rem;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.app-main {
|
||||
flex: 1;
|
||||
overflow: auto;
|
||||
padding: 1.5rem;
|
||||
}
|
||||
|
||||
.report-info {
|
||||
background-image: url('https://cdnjs.cloudflare.com/ajax/libs/Animated_GIF/1.0.1/src/a_gif_sparkle.gif');
|
||||
background-color: rgba(0, 0, 0, 0.7);
|
||||
border: 2px solid #00ffff;
|
||||
box-shadow: 0 0 10px #ff00ff;
|
||||
margin-bottom: 1.5rem;
|
||||
padding: 1rem;
|
||||
border-radius: var(--radius);
|
||||
}
|
||||
|
||||
.report-info h2 {
|
||||
color: #ffffff;
|
||||
text-shadow: 0 0 5px #ff00ff;
|
||||
font-family: 'Comic Sans MS', cursive, sans-serif;
|
||||
}
|
||||
|
||||
.report-date {
|
||||
font-size: 0.875rem;
|
||||
color: #00ffff;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.report-stats {
|
||||
display: flex;
|
||||
gap: 1.5rem;
|
||||
margin-top: 1rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.stat-item {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.25rem;
|
||||
background-color: rgba(0, 0, 0, 0.6);
|
||||
padding: 10px;
|
||||
border: 1px solid #00ffff;
|
||||
border-radius: 5px;
|
||||
}
|
||||
|
||||
.stat-value {
|
||||
color: #ff00ff;
|
||||
text-shadow: 0 0 5px #00ffff;
|
||||
font-size: 1.5rem;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.stat-label {
|
||||
font-size: 0.875rem;
|
||||
color: var(--text-light);
|
||||
text-transform: uppercase;
|
||||
}
|
||||
|
||||
.table-wrapper {
|
||||
overflow-x: auto;
|
||||
border: 2px solid #00ffff;
|
||||
border-radius: var(--radius);
|
||||
box-shadow: 0 0 10px rgba(0, 255, 255, 0.5);
|
||||
}
|
||||
|
||||
.findings-table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
font-size: 0.875rem;
|
||||
}
|
||||
|
||||
.findings-table th {
|
||||
background: linear-gradient(to bottom, #ff00ff, #9900cc);
|
||||
color: white;
|
||||
text-shadow: 0 0 5px black;
|
||||
border: 1px solid #00ffff;
|
||||
padding: 0.75rem;
|
||||
text-align: left;
|
||||
font-weight: 500;
|
||||
position: sticky;
|
||||
top: 0;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
.findings-table td {
|
||||
border: 1px solid #00ffff;
|
||||
background-color: rgba(0, 0, 0, 0.7);
|
||||
padding: 0.75rem;
|
||||
vertical-align: top;
|
||||
max-width: 300px; /* Limit width of all cells */
|
||||
overflow-wrap: break-word;
|
||||
}
|
||||
|
||||
.findings-table tr:hover td {
|
||||
background-color: rgba(255, 0, 255, 0.3);
|
||||
}
|
||||
|
||||
.findings-table th:nth-child(1) { width: 12%; } /* Rule */
|
||||
.findings-table th:nth-child(2) { width: 20%; } /* File */
|
||||
.findings-table th:nth-child(3) { width: 25%; } /* Description */
|
||||
.findings-table th:nth-child(4) { width: 20%; } /* Secret */
|
||||
.findings-table th:nth-child(5) { width: 23%; } /* Metadata */
|
||||
|
||||
.secret-container {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.match-toggle {
|
||||
display: inline-block;
|
||||
margin-top: 0.5rem;
|
||||
background-color: #000000;
|
||||
color: #00ffff;
|
||||
border: 1px solid #ff00ff;
|
||||
font-size: 0.75rem;
|
||||
cursor: pointer;
|
||||
padding: 0.25rem 0.5rem;
|
||||
border-radius: var(--radius);
|
||||
animation: pulse 2s infinite;
|
||||
}
|
||||
|
||||
.match-toggle:hover {
|
||||
background-color: #ff00ff;
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
.hidden {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
.secret-match {
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
word-break: break-all;
|
||||
white-space: pre-wrap;
|
||||
display: block;
|
||||
background-color: rgba(255, 0, 255, 0.3);
|
||||
border: 1px dashed #00ffff;
|
||||
padding: 0.5rem;
|
||||
border-radius: var(--radius);
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.tag-list {
|
||||
display: flex;
|
||||
gap: 0.25rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.tag {
|
||||
display: inline-block;
|
||||
padding: 0.125rem 0.375rem;
|
||||
background-color: #ff00ff;
|
||||
color: white;
|
||||
border-radius: 2px;
|
||||
font-size: 0.75rem;
|
||||
animation: pulse 2s infinite;
|
||||
}
|
||||
|
||||
.meta-row {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));
|
||||
gap: 0.5rem;
|
||||
margin-top: 0.5rem;
|
||||
font-size: 0.75rem;
|
||||
color: var(--text-light);
|
||||
}
|
||||
|
||||
.meta-item {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.25rem;
|
||||
}
|
||||
|
||||
.meta-label {
|
||||
font-weight: 500;
|
||||
color: #00ffff;
|
||||
}
|
||||
|
||||
.meta-value {
|
||||
font-family: var(--font-mono);
|
||||
word-break: break-all;
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
.filters {
|
||||
background-color: rgba(0, 0, 0, 0.7);
|
||||
padding: 15px;
|
||||
border: 2px solid #00ffff;
|
||||
margin-bottom: 20px;
|
||||
box-shadow: 0 0 10px rgba(255, 0, 255, 0.5);
|
||||
display: flex;
|
||||
gap: 1rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.filter-group {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.filter-label {
|
||||
font-size: 0.875rem;
|
||||
font-weight: 600;
|
||||
color: #ff00ff;
|
||||
text-shadow: 0 0 3px #00ffff;
|
||||
}
|
||||
|
||||
.filter-input {
|
||||
background-color: black;
|
||||
color: #00ffff;
|
||||
border: 1px solid #ff00ff;
|
||||
padding: 0.375rem 0.75rem;
|
||||
border-radius: var(--radius);
|
||||
font-size: 0.875rem;
|
||||
font-family: var(--font-main);
|
||||
}
|
||||
|
||||
.filter-input:focus {
|
||||
outline: none;
|
||||
box-shadow: 0 0 10px #ff00ff;
|
||||
}
|
||||
|
||||
.app-footer {
|
||||
background: linear-gradient(to right, #00ffff, #ff00ff);
|
||||
background-size: 200% 100%;
|
||||
animation: rainbow 3s linear infinite reverse;
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
text-shadow: 0 0 2px #ffffff;
|
||||
padding: 0 1.5rem;
|
||||
height: auto;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
border-top: 3px ridge #00ffff;
|
||||
font-size: 0.75rem;
|
||||
flex-shrink: 0;
|
||||
padding: 10px 15px;
|
||||
}
|
||||
|
||||
.description-toggle {
|
||||
cursor: pointer;
|
||||
color: #ff00ff;
|
||||
font-size: 0.875rem;
|
||||
margin-left: 0.5rem;
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 20px;
|
||||
height: 20px;
|
||||
border-radius: 50%;
|
||||
background-color: rgba(0, 0, 0, 0.7);
|
||||
vertical-align: middle;
|
||||
animation: pulse 2s infinite;
|
||||
border: 1px solid #00ffff;
|
||||
}
|
||||
|
||||
.description-toggle:hover {
|
||||
background-color: #ff00ff;
|
||||
color: #000000;
|
||||
}
|
||||
|
||||
.description-expanded {
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
.description-collapsed {
|
||||
white-space: nowrap;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
max-width: 250px;
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.commit-link {
|
||||
color: #ff00ff;
|
||||
text-decoration: underline;
|
||||
text-shadow: 0 0 2px #00ffff;
|
||||
}
|
||||
|
||||
.commit-link:hover {
|
||||
color: #00ffff;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
/* File path styling */
|
||||
.file-path-container {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.file-path {
|
||||
display: inline-block;
|
||||
max-width: 100%;
|
||||
word-wrap: break-word;
|
||||
word-break: break-all;
|
||||
color: #ffffff;
|
||||
}
|
||||
|
||||
.match-content {
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
word-break: break-all;
|
||||
white-space: pre-wrap;
|
||||
display: block;
|
||||
background-color: rgba(0, 0, 0, 0.8);
|
||||
border: 1px solid #ff00ff;
|
||||
padding: 0.5rem;
|
||||
border-radius: var(--radius);
|
||||
margin-top: 0.5rem;
|
||||
max-height: 300px;
|
||||
overflow-y: auto;
|
||||
}
|
||||
|
||||
/* Add sparkles and starry effects to the page */
|
||||
.app-main::before {
|
||||
content: "";
|
||||
position: fixed;
|
||||
top: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
pointer-events: none;
|
||||
background-image: url('https://cdnjs.cloudflare.com/ajax/libs/Animated_GIF/1.0.1/src/a_gif_sparkle.gif');
|
||||
opacity: 0.2;
|
||||
z-index: 999;
|
||||
}
|
||||
|
||||
@keyframes rainbow {
|
||||
0% { background-position: 0% 50%; }
|
||||
50% { background-position: 100% 50%; }
|
||||
100% { background-position: 0% 50%; }
|
||||
}
|
||||
|
||||
@keyframes blink {
|
||||
0% { opacity: 1; }
|
||||
50% { opacity: 0; }
|
||||
100% { opacity: 1; }
|
||||
}
|
||||
|
||||
@keyframes pulse {
|
||||
0% { transform: scale(1); }
|
||||
50% { transform: scale(1.05); }
|
||||
100% { transform: scale(1); }
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
.app-header {
|
||||
padding: 0 1rem;
|
||||
}
|
||||
|
||||
.app-main {
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
.report-stats {
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.filters {
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.app-footer {
|
||||
flex-direction: column;
|
||||
height: auto;
|
||||
padding: 0.75rem 1rem;
|
||||
gap: 0.5rem;
|
||||
justify-content: center;
|
||||
text-align: center;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="app-container">
|
||||
<header class="app-header">
|
||||
<div class="logo">
|
||||
<h1>Gitleaks Security Findings</h1>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<main class="app-main">
|
||||
<div class="report-info">
|
||||
<h2>Security Scan Report</h2>
|
||||
<p class="report-date">Generated on {{now | date "Jan 02, 2006 15:04:05 MST"}}</p>
|
||||
|
||||
<div class="report-stats">
|
||||
<div class="stat-item">
|
||||
<span class="stat-value">{{len .}}</span>
|
||||
<span class="stat-label">Total Findings</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item">
|
||||
<span class="stat-value" id="filesCount">-</span>
|
||||
<span class="stat-label">Files Affected</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item">
|
||||
<span class="stat-value" id="rulesCount">-</span>
|
||||
<span class="stat-label">Unique Rules Triggered</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item" id="scanModeContainer">
|
||||
<span class="stat-value" id="scanMode">-</span>
|
||||
<span class="stat-label">Scan Mode</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="filters">
|
||||
<div class="filter-group">
|
||||
<label class="filter-label" for="filterRule">Filter by Rule:</label>
|
||||
<select class="filter-input" id="filterRule">
|
||||
<option value="all">All Rules</option>
|
||||
<!-- Rule options will be populated by JavaScript -->
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div class="filter-group">
|
||||
<label class="filter-label" for="filterFile">Filter by File:</label>
|
||||
<input type="text" class="filter-input" id="filterFile" placeholder="Enter filename...">
|
||||
</div>
|
||||
|
||||
<div class="filter-group">
|
||||
<button class="btn btn-primary btn-sm" id="resetFilters">Reset Filters</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="table-wrapper">
|
||||
<table class="findings-table" id="findingsTable">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Rule</th>
|
||||
<th>File</th>
|
||||
<th>Description</th>
|
||||
<th>Secret</th>
|
||||
<th>Metadata</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{{- range . }}
|
||||
<tr data-rule="{{.RuleID}}" data-file="{{.File}}">
|
||||
<td>{{.RuleID}}</td>
|
||||
<td>
|
||||
<div class="file-path-container">
|
||||
<span class="file-path" title="{{.File}}">{{.File}}</span>
|
||||
</div>
|
||||
<div class="tag-list">
|
||||
{{- range .Tags }}
|
||||
<span class="tag">{{.}}</span>
|
||||
{{- end}}
|
||||
</div>
|
||||
<div class="meta-row">
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Line:</span>
|
||||
<span class="meta-value">{{.StartLine}}</span>
|
||||
</div>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<span class="description-text">{{.Description}}</span>
|
||||
<span class="description-toggle" title="Expand/Collapse">↕</span>
|
||||
</td>
|
||||
<td>
|
||||
<div class="secret-container" data-secret="{{.Secret}}" data-match="{{.Match}}">
|
||||
<div class="secret-match">{{.Secret}}</div>
|
||||
<button type="button" class="match-toggle" title="Show/Hide Full Match Context">Show Context</button>
|
||||
<div class="match-content hidden" data-raw-match="{{.Match}}">{{.Match}}</div>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<div class="meta-row">
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Entropy:</span>
|
||||
<span class="meta-value">{{printf "%.2f" .Entropy}}</span>
|
||||
</div>
|
||||
{{- if .Commit}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Commit:</span>
|
||||
<span class="meta-value">{{if gt (len .Commit) 7}}{{printf "%.7s" .Commit}}{{else}}{{.Commit}}{{end}}</span>
|
||||
</div>
|
||||
{{- if .Author}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Author:</span>
|
||||
<span class="meta-value">{{.Author}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- if .Date}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Date:</span>
|
||||
<span class="meta-value">{{.Date}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- if .Link}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Link:</span>
|
||||
<span class="meta-value"><a href="{{.Link}}" target="_blank" class="commit-link">View Commit</a></span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- else}}
|
||||
{{- if .Author}}
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Author:</span>
|
||||
<span class="meta-value">{{.Author}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- end}}
|
||||
</div>
|
||||
|
||||
{{- if not .Match}}
|
||||
<div class="match-content" data-raw-match="">-</div>
|
||||
{{- end}}
|
||||
</td>
|
||||
</tr>
|
||||
{{- end }}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<footer class="app-footer">
|
||||
<div>Generated by Gitleaks</div>
|
||||
<div>Total Findings: <strong>{{len .}}</strong></div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
// Process data to collect unique files and rules
|
||||
function processData() {
|
||||
const rows = document.querySelectorAll('#findingsTable tbody tr');
|
||||
const uniqueRules = new Set();
|
||||
const uniqueFiles = new Set();
|
||||
let isGitMode = false;
|
||||
|
||||
if (rows.length > 0) {
|
||||
// Check if first finding has commit data to determine mode
|
||||
const firstRow = rows[0];
|
||||
const commitCells = firstRow.querySelectorAll('.commit-info');
|
||||
isGitMode = commitCells.length > 0 && commitCells[0].textContent.trim() !== '';
|
||||
}
|
||||
|
||||
// Set scan mode
|
||||
document.getElementById('scanMode').textContent = isGitMode ? 'Git' : 'Directory';
|
||||
|
||||
// Adjust UI based on mode
|
||||
if (isGitMode) {
|
||||
// Ensure commit info columns are visible for git mode
|
||||
document.querySelectorAll('.commit-info').forEach(el => {
|
||||
el.style.display = 'block';
|
||||
});
|
||||
} else {
|
||||
// Hide commit-specific UI elements for directory mode
|
||||
document.querySelectorAll('.commit-info').forEach(el => {
|
||||
el.style.display = 'none';
|
||||
});
|
||||
}
|
||||
|
||||
rows.forEach(row => {
|
||||
uniqueRules.add(row.dataset.rule);
|
||||
uniqueFiles.add(row.dataset.file);
|
||||
});
|
||||
|
||||
// Update stats
|
||||
document.getElementById('filesCount').textContent = uniqueFiles.size;
|
||||
document.getElementById('rulesCount').textContent = uniqueRules.size;
|
||||
|
||||
// Populate rule filter dropdown
|
||||
const ruleFilter = document.getElementById('filterRule');
|
||||
const sortedRules = Array.from(uniqueRules).sort();
|
||||
sortedRules.forEach(rule => {
|
||||
const option = document.createElement('option');
|
||||
option.value = rule;
|
||||
option.textContent = rule;
|
||||
ruleFilter.appendChild(option);
|
||||
});
|
||||
}
|
||||
|
||||
// Hide toggle button if match is same as secret
|
||||
function hideRedundantToggleButtons() {
|
||||
document.querySelectorAll('.secret-container').forEach(container => {
|
||||
const secret = container.getAttribute('data-secret');
|
||||
const match = container.getAttribute('data-match');
|
||||
const toggleButton = container.querySelector('.match-toggle');
|
||||
|
||||
// If secret and match are the same, or if match is empty, hide the toggle button
|
||||
if ((secret && match && secret.trim() === match.trim()) || !match) {
|
||||
if (toggleButton) {
|
||||
toggleButton.style.display = 'none';
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Setup toggle buttons
|
||||
function setupToggleButtons() {
|
||||
document.querySelectorAll('.match-toggle').forEach(btn => {
|
||||
btn.addEventListener('click', function() {
|
||||
const matchContent = this.nextElementSibling;
|
||||
if (matchContent.classList.contains('hidden')) {
|
||||
matchContent.classList.remove('hidden');
|
||||
this.textContent = 'Hide Context';
|
||||
} else {
|
||||
matchContent.classList.add('hidden');
|
||||
this.textContent = 'Show Context';
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Setup description toggle
|
||||
document.querySelectorAll('.description-text').forEach(descriptionText => {
|
||||
const toggleBtn = descriptionText.nextElementSibling;
|
||||
if (!toggleBtn || !toggleBtn.classList.contains('description-toggle')) return;
|
||||
|
||||
// Initial state: collapsed
|
||||
descriptionText.classList.add('description-collapsed');
|
||||
|
||||
toggleBtn.addEventListener('click', () => {
|
||||
if (descriptionText.classList.contains('description-collapsed')) {
|
||||
descriptionText.classList.remove('description-collapsed');
|
||||
descriptionText.classList.add('description-expanded');
|
||||
toggleBtn.textContent = '↑';
|
||||
} else {
|
||||
descriptionText.classList.remove('description-expanded');
|
||||
descriptionText.classList.add('description-collapsed');
|
||||
toggleBtn.textContent = '↕';
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// Add some MySpace-style effects
|
||||
function addMySpaceEffects() {
|
||||
// Maybe add some sparkle effects to the header on load
|
||||
const header = document.querySelector('.app-header');
|
||||
for (let i = 0; i < 5; i++) {
|
||||
setTimeout(() => {
|
||||
header.style.boxShadow = '0 0 20px #ff00ff';
|
||||
setTimeout(() => {
|
||||
header.style.boxShadow = '0 0 10px #00ffff';
|
||||
}, 100);
|
||||
}, i * 200);
|
||||
}
|
||||
}
|
||||
|
||||
// Filter functionality
|
||||
function applyFilters() {
|
||||
const ruleFilter = document.getElementById('filterRule').value;
|
||||
const fileFilter = document.getElementById('filterFile').value.toLowerCase();
|
||||
|
||||
const rows = document.querySelectorAll('#findingsTable tbody tr');
|
||||
|
||||
rows.forEach(row => {
|
||||
const ruleMatch = ruleFilter === 'all' || row.dataset.rule === ruleFilter;
|
||||
const fileMatch = fileFilter === '' || row.dataset.file.toLowerCase().includes(fileFilter);
|
||||
|
||||
if (ruleMatch && fileMatch) {
|
||||
row.style.display = '';
|
||||
} else {
|
||||
row.style.display = 'none';
|
||||
}
|
||||
});
|
||||
|
||||
// Update visible count
|
||||
const visibleFindings = document.querySelectorAll('#findingsTable tbody tr:not([style*="display: none"])').length;
|
||||
document.querySelector('.app-footer strong').textContent = visibleFindings;
|
||||
}
|
||||
|
||||
document.getElementById('filterRule').addEventListener('change', applyFilters);
|
||||
document.getElementById('filterFile').addEventListener('input', applyFilters);
|
||||
document.getElementById('resetFilters').addEventListener('click', function() {
|
||||
document.getElementById('filterRule').value = 'all';
|
||||
document.getElementById('filterFile').value = '';
|
||||
applyFilters();
|
||||
});
|
||||
|
||||
// Initialize
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
processData();
|
||||
hideRedundantToggleButtons(); // Hide toggle buttons for matching secrets
|
||||
setupToggleButtons();
|
||||
addMySpaceEffects(); // Add some fun MySpace-style effects
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
723
templates/w98.tmpl
Normal file
723
templates/w98.tmpl
Normal file
@ -0,0 +1,723 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Gitleaks Security Findings Report</title>
|
||||
<style>
|
||||
:root {
|
||||
--primary-color: #000080;
|
||||
--primary-color-rgb: 0, 0, 128;
|
||||
--primary-dark: #000066;
|
||||
--primary-light: #0000aa;
|
||||
--secondary-color: #c0c0c0;
|
||||
--surface-color: #c0c0c0;
|
||||
--border-color: #808080;
|
||||
--text-color: #000000;
|
||||
--text-light: #404040;
|
||||
--text-inverse: #ffffff;
|
||||
--error-color: #ff0000;
|
||||
--warning-color: #ffaa00;
|
||||
--success-color: #008000;
|
||||
--highlight-color: rgba(0, 0, 128, 0.2);
|
||||
--highlight-secret: rgba(255, 0, 0, 0.2);
|
||||
--shadow: 2px 2px 0 rgba(0, 0, 0, 0.5);
|
||||
--radius: 0;
|
||||
--font-mono: 'Courier New', monospace;
|
||||
--font-main: 'MS Sans Serif', 'Tahoma', sans-serif;
|
||||
}
|
||||
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
html, body {
|
||||
height: 100%;
|
||||
font-family: var(--font-main);
|
||||
font-size: 16px;
|
||||
line-height: 1.5;
|
||||
color: var(--text-color);
|
||||
background-color: #008080;
|
||||
background-image: url("data:image/svg+xml,%3Csvg width='40' height='40' viewBox='0 0 40 40' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M0 0h40v40H0V0zm20 10a10 10 0 1 1 0 20 10 10 0 0 1 0-20z' fill='%23009090' fill-opacity='0.2' fill-rule='evenodd'/%3E%3C/svg%3E");
|
||||
}
|
||||
|
||||
.app-container {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
height: 100%;
|
||||
max-width: 100%;
|
||||
overflow: hidden;
|
||||
border: 2px outset #d4d0c8;
|
||||
box-shadow: 2px 2px 10px rgba(0, 0, 0, 0.3);
|
||||
}
|
||||
|
||||
.app-header {
|
||||
height: 28px;
|
||||
background: linear-gradient(to right, #000080, #1084d0);
|
||||
color: var(--text-inverse);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
padding: 1px 2px;
|
||||
flex-shrink: 0;
|
||||
box-shadow: var(--shadow);
|
||||
z-index: 10;
|
||||
border-bottom: 2px outset #ffffff;
|
||||
}
|
||||
|
||||
.logo h1 {
|
||||
font-size: 14px;
|
||||
font-weight: bold;
|
||||
margin: 0;
|
||||
padding: 4px 2px;
|
||||
text-shadow: 1px 1px 0 rgba(0, 0, 0, 0.5);
|
||||
}
|
||||
|
||||
.btn {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
background-color: #c0c0c0;
|
||||
color: #000000;
|
||||
border: 2px outset #d4d0c8;
|
||||
border-radius: 0;
|
||||
font-size: 12px;
|
||||
padding: 3px 6px;
|
||||
box-shadow: 1px 1px 0 #ffffff inset, -1px -1px 0 #808080 inset;
|
||||
cursor: pointer;
|
||||
transition: background-color 0.2s, color 0.2s;
|
||||
font-family: var(--font-main);
|
||||
}
|
||||
|
||||
.btn:active {
|
||||
border: 2px inset #d4d0c8;
|
||||
box-shadow: 1px 1px 0 #808080 inset, -1px -1px 0 #ffffff inset;
|
||||
padding: 4px 5px 2px 7px;
|
||||
}
|
||||
|
||||
.btn-primary {
|
||||
background-color: var(--primary-color);
|
||||
color: var(--text-inverse);
|
||||
}
|
||||
|
||||
.btn-primary:hover {
|
||||
background-color: var(--primary-dark);
|
||||
}
|
||||
|
||||
.btn-sm {
|
||||
padding: 1px 3px;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.app-main {
|
||||
flex: 1;
|
||||
overflow: auto;
|
||||
padding: 1.5rem;
|
||||
}
|
||||
|
||||
.report-info {
|
||||
margin-bottom: 1.5rem;
|
||||
padding: 8px;
|
||||
background-color: #c0c0c0;
|
||||
border: 2px inset #d4d0c8;
|
||||
}
|
||||
|
||||
.report-date {
|
||||
font-size: 0.875rem;
|
||||
color: var(--text-light);
|
||||
}
|
||||
|
||||
.report-stats {
|
||||
display: flex;
|
||||
gap: 1.5rem;
|
||||
margin-top: 1rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.stat-item {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.25rem;
|
||||
}
|
||||
|
||||
.stat-value {
|
||||
font-size: 1.25rem;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.stat-label {
|
||||
font-size: 0.875rem;
|
||||
color: var(--text-light);
|
||||
}
|
||||
|
||||
.table-wrapper {
|
||||
overflow-x: auto;
|
||||
border: 2px inset #d4d0c8;
|
||||
}
|
||||
|
||||
.findings-table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
font-size: 0.875rem;
|
||||
}
|
||||
|
||||
.findings-table th {
|
||||
background-color: #000080;
|
||||
color: white;
|
||||
font-weight: bold;
|
||||
font-size: 12px;
|
||||
padding: 4px 6px;
|
||||
border: 1px solid #808080;
|
||||
position: sticky;
|
||||
top: 0;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
/* Ensure table cells don't expand too much */
|
||||
.findings-table td {
|
||||
background-color: #ffffff;
|
||||
border: 1px solid #d4d0c8;
|
||||
font-size: 12px;
|
||||
padding: 4px 6px;
|
||||
vertical-align: top;
|
||||
max-width: 300px; /* Limit width of all cells */
|
||||
overflow-wrap: break-word;
|
||||
}
|
||||
|
||||
.findings-table tr:hover td {
|
||||
background-color: #e6e6e6;
|
||||
}
|
||||
|
||||
.findings-table th:nth-child(1) { width: 12%; } /* Rule */
|
||||
.findings-table th:nth-child(2) { width: 20%; } /* File */
|
||||
.findings-table th:nth-child(3) { width: 25%; } /* Description */
|
||||
.findings-table th:nth-child(4) { width: 20%; } /* Secret */
|
||||
.findings-table th:nth-child(5) { width: 23%; } /* Metadata */
|
||||
|
||||
.secret-container {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.match-toggle {
|
||||
display: inline-block;
|
||||
margin-top: 0.5rem;
|
||||
background-color: #c0c0c0;
|
||||
border: 2px outset #d4d0c8;
|
||||
color: #000000;
|
||||
font-size: 10px;
|
||||
padding: 1px 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.match-toggle:active {
|
||||
border: 2px inset #d4d0c8;
|
||||
}
|
||||
|
||||
.hidden {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
.secret-match {
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
word-break: break-all;
|
||||
white-space: pre-wrap;
|
||||
display: block;
|
||||
background-color: #ffffff;
|
||||
border: 1px solid #808080;
|
||||
padding: 0.5rem;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.tag-list {
|
||||
display: flex;
|
||||
gap: 0.25rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.tag {
|
||||
display: inline-block;
|
||||
background-color: #000080;
|
||||
border-radius: 0;
|
||||
padding: 1px 3px;
|
||||
font-size: 10px;
|
||||
color: var(--text-inverse);
|
||||
}
|
||||
|
||||
.meta-row {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));
|
||||
gap: 0.5rem;
|
||||
margin-top: 0.5rem;
|
||||
font-size: 0.75rem;
|
||||
color: var(--text-light);
|
||||
}
|
||||
|
||||
.meta-item {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.25rem;
|
||||
}
|
||||
|
||||
.meta-label {
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.meta-value {
|
||||
font-family: var(--font-mono);
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
.code-preview {
|
||||
position: relative;
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
background-color: #ffffff;
|
||||
padding: 0.5rem;
|
||||
border: 1px solid #808080;
|
||||
overflow-x: auto;
|
||||
margin-top: 0.5rem;
|
||||
white-space: pre-wrap;
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
.filters {
|
||||
margin-bottom: 12px;
|
||||
background-color: #c0c0c0;
|
||||
padding: 8px;
|
||||
border: 2px outset #d4d0c8;
|
||||
display: flex;
|
||||
gap: 1rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.filter-group {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
|
||||
.filter-label {
|
||||
font-size: 12px;
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
.filter-input {
|
||||
background-color: #ffffff;
|
||||
border: 2px inset #d4d0c8;
|
||||
padding: 3px 4px;
|
||||
font-size: 12px;
|
||||
font-family: var(--font-main);
|
||||
}
|
||||
|
||||
.app-footer {
|
||||
background-color: #c0c0c0;
|
||||
border-top: 2px outset #d4d0c8;
|
||||
font-size: 11px;
|
||||
padding: 3px 8px;
|
||||
height: 24px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
.description-toggle {
|
||||
cursor: pointer;
|
||||
color: var(--primary-color);
|
||||
font-size: 0.875rem;
|
||||
margin-left: 0.5rem;
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
background-color: #c0c0c0;
|
||||
border: 1px outset #d4d0c8;
|
||||
font-size: 10px;
|
||||
line-height: 14px;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
.description-toggle:hover {
|
||||
background-color: var(--primary-light);
|
||||
color: var(--text-inverse);
|
||||
}
|
||||
|
||||
.description-expanded {
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
.description-collapsed {
|
||||
white-space: nowrap;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
max-width: 250px;
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.commit-link {
|
||||
color: var(--primary-color);
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.commit-link:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
/* File path styling */
|
||||
.file-path-container {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.file-path {
|
||||
display: inline-block;
|
||||
max-width: 100%;
|
||||
word-wrap: break-word;
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
.match-content {
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
word-break: break-all;
|
||||
white-space: pre-wrap;
|
||||
display: block;
|
||||
background-color: #ffffff;
|
||||
border: 1px solid #808080;
|
||||
padding: 0.5rem;
|
||||
margin-top: 0.5rem;
|
||||
max-height: 300px;
|
||||
overflow-y: auto;
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
.app-header {
|
||||
padding: 0 1rem;
|
||||
}
|
||||
|
||||
.app-main {
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
.report-stats {
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.filters {
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.app-footer {
|
||||
flex-direction: column;
|
||||
height: auto;
|
||||
padding: 0.75rem 1rem;
|
||||
gap: 0.5rem;
|
||||
justify-content: center;
|
||||
text-align: center;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="app-container">
|
||||
<header class="app-header">
|
||||
<div class="logo">
|
||||
<h1>Gitleaks Security Findings</h1>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<main class="app-main">
|
||||
<div class="report-info">
|
||||
<h2>Security Scan Report</h2>
|
||||
<p class="report-date">Generated on {{now | date "Jan 02, 2006 15:04:05 MST"}}</p>
|
||||
|
||||
<div class="report-stats">
|
||||
<div class="stat-item">
|
||||
<span class="stat-value">{{len .}}</span>
|
||||
<span class="stat-label">Total Findings</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item">
|
||||
<span class="stat-value" id="filesCount">-</span>
|
||||
<span class="stat-label">Files Affected</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item">
|
||||
<span class="stat-value" id="rulesCount">-</span>
|
||||
<span class="stat-label">Unique Rules Triggered</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item" id="scanModeContainer">
|
||||
<span class="stat-value" id="scanMode">-</span>
|
||||
<span class="stat-label">Scan Mode</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="filters">
|
||||
<div class="filter-group">
|
||||
<label class="filter-label" for="filterRule">Filter by Rule:</label>
|
||||
<select class="filter-input" id="filterRule">
|
||||
<option value="all">All Rules</option>
|
||||
<!-- Rule options will be populated by JavaScript -->
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div class="filter-group">
|
||||
<label class="filter-label" for="filterFile">Filter by File:</label>
|
||||
<input type="text" class="filter-input" id="filterFile" placeholder="Enter filename...">
|
||||
</div>
|
||||
|
||||
<div class="filter-group">
|
||||
<button class="btn btn-primary btn-sm" id="resetFilters">Reset Filters</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="table-wrapper">
|
||||
<table class="findings-table" id="findingsTable">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Rule</th>
|
||||
<th>File</th>
|
||||
<th>Description</th>
|
||||
<th>Secret</th>
|
||||
<th>Metadata</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{{- range . }}
|
||||
<tr data-rule="{{.RuleID}}" data-file="{{.File}}">
|
||||
<td>{{.RuleID}}</td>
|
||||
<td>
|
||||
<div class="file-path-container">
|
||||
<span class="file-path" title="{{.File}}">{{.File}}</span>
|
||||
</div>
|
||||
<div class="tag-list">
|
||||
{{- range .Tags }}
|
||||
<span class="tag">{{.}}</span>
|
||||
{{- end}}
|
||||
</div>
|
||||
<div class="meta-row">
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Line:</span>
|
||||
<span class="meta-value">{{.StartLine}}</span>
|
||||
</div>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<span class="description-text">{{.Description}}</span>
|
||||
<span class="description-toggle" title="Expand/Collapse">↕</span>
|
||||
</td>
|
||||
<td>
|
||||
<div class="secret-container" data-secret="{{.Secret}}" data-match="{{.Match}}">
|
||||
<div class="secret-match">{{.Secret}}</div>
|
||||
<button type="button" class="match-toggle" title="Show/Hide Full Match Context">Show Context</button>
|
||||
<div class="match-content hidden" data-raw-match="{{.Match}}">{{.Match}}</div>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<div class="meta-row">
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Entropy:</span>
|
||||
<span class="meta-value">{{printf "%.2f" .Entropy}}</span>
|
||||
</div>
|
||||
{{- if .Commit}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Commit:</span>
|
||||
<span class="meta-value">{{if gt (len .Commit) 7}}{{printf "%.7s" .Commit}}{{else}}{{.Commit}}{{end}}</span>
|
||||
</div>
|
||||
{{- if .Author}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Author:</span>
|
||||
<span class="meta-value">{{.Author}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- if .Date}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Date:</span>
|
||||
<span class="meta-value">{{.Date}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- if .Link}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Link:</span>
|
||||
<span class="meta-value"><a href="{{.Link}}" target="_blank" class="commit-link">View Commit</a></span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- else}}
|
||||
{{- if .Author}}
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Author:</span>
|
||||
<span class="meta-value">{{.Author}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- end}}
|
||||
</div>
|
||||
|
||||
{{- if not .Match}}
|
||||
<div class="match-content" data-raw-match="">-</div>
|
||||
{{- end}}
|
||||
</td>
|
||||
</tr>
|
||||
{{- end }}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<footer class="app-footer">
|
||||
<div>Generated by Gitleaks</div>
|
||||
<div>Total Findings: <strong>{{len .}}</strong></div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
// Process data to collect unique files and rules
|
||||
function processData() {
|
||||
const rows = document.querySelectorAll('#findingsTable tbody tr');
|
||||
const uniqueRules = new Set();
|
||||
const uniqueFiles = new Set();
|
||||
let isGitMode = false;
|
||||
|
||||
if (rows.length > 0) {
|
||||
// Check if first finding has commit data to determine mode
|
||||
const firstRow = rows[0];
|
||||
const commitCells = firstRow.querySelectorAll('.commit-info');
|
||||
isGitMode = commitCells.length > 0 && commitCells[0].textContent.trim() !== '';
|
||||
}
|
||||
|
||||
// Set scan mode
|
||||
document.getElementById('scanMode').textContent = isGitMode ? 'Git' : 'Directory';
|
||||
|
||||
// Adjust UI based on mode
|
||||
if (isGitMode) {
|
||||
// Ensure commit info columns are visible for git mode
|
||||
document.querySelectorAll('.commit-info').forEach(el => {
|
||||
el.style.display = 'block';
|
||||
});
|
||||
} else {
|
||||
// Hide commit-specific UI elements for directory mode
|
||||
document.querySelectorAll('.commit-info').forEach(el => {
|
||||
el.style.display = 'none';
|
||||
});
|
||||
}
|
||||
|
||||
rows.forEach(row => {
|
||||
uniqueRules.add(row.dataset.rule);
|
||||
uniqueFiles.add(row.dataset.file);
|
||||
});
|
||||
|
||||
// Update stats
|
||||
document.getElementById('filesCount').textContent = uniqueFiles.size;
|
||||
document.getElementById('rulesCount').textContent = uniqueRules.size;
|
||||
|
||||
// Populate rule filter dropdown
|
||||
const ruleFilter = document.getElementById('filterRule');
|
||||
const sortedRules = Array.from(uniqueRules).sort();
|
||||
sortedRules.forEach(rule => {
|
||||
const option = document.createElement('option');
|
||||
option.value = rule;
|
||||
option.textContent = rule;
|
||||
ruleFilter.appendChild(option);
|
||||
});
|
||||
}
|
||||
|
||||
// Hide toggle button if match is same as secret
|
||||
function hideRedundantToggleButtons() {
|
||||
document.querySelectorAll('.secret-container').forEach(container => {
|
||||
const secret = container.getAttribute('data-secret');
|
||||
const match = container.getAttribute('data-match');
|
||||
const toggleButton = container.querySelector('.match-toggle');
|
||||
|
||||
// If secret and match are the same, or if match is empty, hide the toggle button
|
||||
if ((secret && match && secret.trim() === match.trim()) || !match) {
|
||||
if (toggleButton) {
|
||||
toggleButton.style.display = 'none';
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Setup toggle buttons
|
||||
function setupToggleButtons() {
|
||||
document.querySelectorAll('.match-toggle').forEach(btn => {
|
||||
btn.addEventListener('click', function() {
|
||||
const matchContent = this.nextElementSibling;
|
||||
if (matchContent.classList.contains('hidden')) {
|
||||
matchContent.classList.remove('hidden');
|
||||
this.textContent = 'Hide Context';
|
||||
} else {
|
||||
matchContent.classList.add('hidden');
|
||||
this.textContent = 'Show Context';
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Setup description toggle
|
||||
document.querySelectorAll('.description-text').forEach(descriptionText => {
|
||||
const toggleBtn = descriptionText.nextElementSibling;
|
||||
if (!toggleBtn || !toggleBtn.classList.contains('description-toggle')) return;
|
||||
|
||||
// Initial state: collapsed
|
||||
descriptionText.classList.add('description-collapsed');
|
||||
|
||||
toggleBtn.addEventListener('click', () => {
|
||||
if (descriptionText.classList.contains('description-collapsed')) {
|
||||
descriptionText.classList.remove('description-collapsed');
|
||||
descriptionText.classList.add('description-expanded');
|
||||
toggleBtn.textContent = '↑';
|
||||
} else {
|
||||
descriptionText.classList.remove('description-expanded');
|
||||
descriptionText.classList.add('description-collapsed');
|
||||
toggleBtn.textContent = '↕';
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// Filter functionality
|
||||
function applyFilters() {
|
||||
const ruleFilter = document.getElementById('filterRule').value;
|
||||
const fileFilter = document.getElementById('filterFile').value.toLowerCase();
|
||||
|
||||
const rows = document.querySelectorAll('#findingsTable tbody tr');
|
||||
|
||||
rows.forEach(row => {
|
||||
const ruleMatch = ruleFilter === 'all' || row.dataset.rule === ruleFilter;
|
||||
const fileMatch = fileFilter === '' || row.dataset.file.toLowerCase().includes(fileFilter);
|
||||
|
||||
if (ruleMatch && fileMatch) {
|
||||
row.style.display = '';
|
||||
} else {
|
||||
row.style.display = 'none';
|
||||
}
|
||||
});
|
||||
|
||||
// Update visible count
|
||||
const visibleFindings = document.querySelectorAll('#findingsTable tbody tr:not([style*="display: none"])').length;
|
||||
document.querySelector('.app-footer strong').textContent = visibleFindings;
|
||||
}
|
||||
|
||||
document.getElementById('filterRule').addEventListener('change', applyFilters);
|
||||
document.getElementById('filterFile').addEventListener('input', applyFilters);
|
||||
document.getElementById('resetFilters').addEventListener('click', function() {
|
||||
document.getElementById('filterRule').value = 'all';
|
||||
document.getElementById('filterFile').value = '';
|
||||
applyFilters();
|
||||
});
|
||||
|
||||
// Initialize
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
processData();
|
||||
hideRedundantToggleButtons(); // Hide toggle buttons for matching secrets
|
||||
setupToggleButtons();
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
760
templates/wxp.tmpl
Normal file
760
templates/wxp.tmpl
Normal file
@ -0,0 +1,760 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Gitleaks Security Findings Report</title>
|
||||
<style>
|
||||
:root {
|
||||
--primary-color: #2c5fb2;
|
||||
--primary-color-rgb: 44, 95, 178;
|
||||
--primary-dark: #224486;
|
||||
--primary-light: #356bc9;
|
||||
--secondary-color: #eef3ff;
|
||||
--surface-color: #ffffff;
|
||||
--border-color: #7da2ce;
|
||||
--text-color: #000000;
|
||||
--text-light: #3a6ea5;
|
||||
--text-inverse: #ffffff;
|
||||
--error-color: #cc0000;
|
||||
--warning-color: #ffaa00;
|
||||
--success-color: #50c878;
|
||||
--highlight-color: rgba(44, 95, 178, 0.2);
|
||||
--highlight-secret: rgba(204, 0, 0, 0.2);
|
||||
--shadow: 0 2px 4px rgba(0, 0, 0, 0.3);
|
||||
--radius: 8px;
|
||||
--font-mono: 'Lucida Console', monospace;
|
||||
--font-main: 'Tahoma', 'Segoe UI', sans-serif;
|
||||
}
|
||||
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
html, body {
|
||||
height: 100%;
|
||||
font-family: var(--font-main);
|
||||
font-size: 16px;
|
||||
line-height: 1.5;
|
||||
color: var(--text-color);
|
||||
background-color: var(--surface-color);
|
||||
background: linear-gradient(to bottom, #a1c8e9, #2573d1);
|
||||
background-attachment: fixed;
|
||||
}
|
||||
|
||||
.app-container {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
height: 100%;
|
||||
max-width: 100%;
|
||||
overflow: hidden;
|
||||
border-radius: 8px;
|
||||
box-shadow: 0 0 10px rgba(0, 0, 0, 0.5);
|
||||
border: 1px solid #7da2ce;
|
||||
}
|
||||
|
||||
.app-header {
|
||||
height: 36px;
|
||||
background: linear-gradient(to bottom, #3689de, #2c5fb2, #2151a3);
|
||||
color: var(--text-inverse);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
padding: 0 12px;
|
||||
flex-shrink: 0;
|
||||
box-shadow: var(--shadow);
|
||||
z-index: 10;
|
||||
border-bottom: 1px solid #1a3c71;
|
||||
}
|
||||
|
||||
.logo h1 {
|
||||
font-size: 16px;
|
||||
font-weight: bold;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
text-shadow: 1px 1px 0 rgba(0, 0, 0, 0.5);
|
||||
}
|
||||
|
||||
.btn {
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
background: linear-gradient(to bottom, #f1f8fe, #d8e6f6);
|
||||
color: #000000;
|
||||
border: 1px solid #7da2ce;
|
||||
border-radius: 3px;
|
||||
font-size: 12px;
|
||||
padding: 4px 8px;
|
||||
box-shadow: 0 1px 0 rgba(255, 255, 255, 0.7) inset;
|
||||
cursor: pointer;
|
||||
transition: background-color 0.2s, color 0.2s;
|
||||
font-family: var(--font-main);
|
||||
}
|
||||
|
||||
.btn:hover {
|
||||
background: linear-gradient(to bottom, #e5f1fd, #c7ddfa);
|
||||
}
|
||||
|
||||
.btn:active {
|
||||
background: linear-gradient(to bottom, #c7ddfa, #e5f1fd);
|
||||
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.2) inset;
|
||||
}
|
||||
|
||||
.btn-primary {
|
||||
background: linear-gradient(to bottom, #3689de, #2c5fb2);
|
||||
color: white;
|
||||
border: 1px solid #1a3c71;
|
||||
}
|
||||
|
||||
.btn-primary:hover {
|
||||
background: linear-gradient(to bottom, #4397e9, #3670c3);
|
||||
}
|
||||
|
||||
.btn-primary:active {
|
||||
background: linear-gradient(to bottom, #2151a3, #3689de);
|
||||
}
|
||||
|
||||
.btn-sm {
|
||||
padding: 2px 5px;
|
||||
font-size: 0.75rem;
|
||||
}
|
||||
|
||||
.app-main {
|
||||
flex: 1;
|
||||
overflow: auto;
|
||||
padding: 1.5rem;
|
||||
}
|
||||
|
||||
.report-info {
|
||||
background-color: #eef3ff;
|
||||
border: 1px solid #7da2ce;
|
||||
border-radius: 5px;
|
||||
padding: 12px;
|
||||
margin-bottom: 15px;
|
||||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
.report-info h2 {
|
||||
color: #2c5fb2;
|
||||
margin-top: 0;
|
||||
font-size: 18px;
|
||||
}
|
||||
|
||||
.report-date {
|
||||
color: #3a6ea5;
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
.report-stats {
|
||||
display: flex;
|
||||
gap: 1.5rem;
|
||||
margin-top: 1rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.stat-item {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.25rem;
|
||||
}
|
||||
|
||||
.stat-value {
|
||||
font-size: 1.25rem;
|
||||
font-weight: 600;
|
||||
color: #2c5fb2;
|
||||
}
|
||||
|
||||
.stat-label {
|
||||
font-size: 0.875rem;
|
||||
color: var(--text-light);
|
||||
}
|
||||
|
||||
.table-wrapper {
|
||||
overflow-x: auto;
|
||||
border: 1px solid #7da2ce;
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
.findings-table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
font-size: 0.875rem;
|
||||
}
|
||||
|
||||
.findings-table th {
|
||||
background: linear-gradient(to bottom, #e5f1fd, #c7ddfa);
|
||||
color: #2c5fb2;
|
||||
font-weight: bold;
|
||||
font-size: 13px;
|
||||
padding: 8px;
|
||||
border: 1px solid #7da2ce;
|
||||
text-align: left;
|
||||
position: sticky;
|
||||
top: 0;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
/* Ensure table cells don't expand too much */
|
||||
.findings-table td {
|
||||
background-color: #ffffff;
|
||||
border: 1px solid #d9e6f7;
|
||||
font-size: 12px;
|
||||
padding: 8px;
|
||||
vertical-align: top;
|
||||
max-width: 300px; /* Limit width of all cells */
|
||||
overflow-wrap: break-word;
|
||||
}
|
||||
|
||||
.findings-table tr:nth-child(even) td {
|
||||
background-color: #f5f9ff;
|
||||
}
|
||||
|
||||
.findings-table tr:hover td {
|
||||
background-color: #e5f1fd;
|
||||
}
|
||||
|
||||
.findings-table th:nth-child(1) { width: 12%; } /* Rule */
|
||||
.findings-table th:nth-child(2) { width: 20%; } /* File */
|
||||
.findings-table th:nth-child(3) { width: 25%; } /* Description */
|
||||
.findings-table th:nth-child(4) { width: 20%; } /* Secret */
|
||||
.findings-table th:nth-child(5) { width: 23%; } /* Metadata */
|
||||
|
||||
.secret-container {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.match-toggle {
|
||||
display: inline-block;
|
||||
margin-top: 0.5rem;
|
||||
background: linear-gradient(to bottom, #f1f8fe, #d8e6f6);
|
||||
border: 1px solid #7da2ce;
|
||||
color: #2c5fb2;
|
||||
font-size: 11px;
|
||||
border-radius: 3px;
|
||||
padding: 2px 5px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.match-toggle:hover {
|
||||
background: linear-gradient(to bottom, #e5f1fd, #c7ddfa);
|
||||
}
|
||||
|
||||
.hidden {
|
||||
display: none !important;
|
||||
}
|
||||
|
||||
.secret-match {
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
word-break: break-all;
|
||||
white-space: pre-wrap;
|
||||
display: block;
|
||||
background-color: #f9f2f2;
|
||||
border: 1px solid #e0c0c0;
|
||||
border-radius: 3px;
|
||||
padding: 0.5rem;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.tag-list {
|
||||
display: flex;
|
||||
gap: 0.25rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.tag {
|
||||
display: inline-block;
|
||||
padding: 2px 5px;
|
||||
background-color: #3689de;
|
||||
color: var(--text-inverse);
|
||||
border-radius: 3px;
|
||||
font-size: 10px;
|
||||
margin: 2px;
|
||||
}
|
||||
|
||||
.meta-row {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));
|
||||
gap: 0.5rem;
|
||||
margin-top: 0.5rem;
|
||||
font-size: 0.75rem;
|
||||
color: var(--text-light);
|
||||
}
|
||||
|
||||
.meta-item {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.25rem;
|
||||
}
|
||||
|
||||
.meta-label {
|
||||
font-weight: 500;
|
||||
color: #2c5fb2;
|
||||
}
|
||||
|
||||
.meta-value {
|
||||
font-family: var(--font-mono);
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
.code-preview {
|
||||
position: relative;
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
background-color: var(--secondary-color);
|
||||
padding: 0.5rem;
|
||||
border-radius: var(--radius);
|
||||
overflow-x: auto;
|
||||
margin-top: 0.5rem;
|
||||
white-space: pre-wrap;
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
.filters {
|
||||
margin-bottom: 15px;
|
||||
background-color: #eef3ff;
|
||||
padding: 10px;
|
||||
border: 1px solid #7da2ce;
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
||||
display: flex;
|
||||
gap: 1rem;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.filter-group {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 0.5rem;
|
||||
margin-right: 15px;
|
||||
}
|
||||
|
||||
.filter-label {
|
||||
font-size: 12px;
|
||||
font-weight: bold;
|
||||
color: #2c5fb2;
|
||||
}
|
||||
|
||||
.filter-input {
|
||||
background-color: white;
|
||||
border: 1px solid #7da2ce;
|
||||
border-radius: 3px;
|
||||
padding: 3px 6px;
|
||||
font-size: 12px;
|
||||
box-shadow: 0 1px 2px rgba(0, 0, 0, 0.05) inset;
|
||||
font-family: var(--font-main);
|
||||
}
|
||||
|
||||
.app-footer {
|
||||
background: linear-gradient(to bottom, #eef3ff, #d8e6f6);
|
||||
border-top: 1px solid #7da2ce;
|
||||
font-size: 11px;
|
||||
padding: 8px 12px;
|
||||
color: #2c5fb2;
|
||||
height: auto;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
flex-shrink: 0;
|
||||
}
|
||||
|
||||
.description-toggle {
|
||||
cursor: pointer;
|
||||
color: #2c5fb2;
|
||||
font-size: 0.875rem;
|
||||
margin-left: 0.5rem;
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
width: 20px;
|
||||
height: 20px;
|
||||
border-radius: 50%;
|
||||
background: linear-gradient(to bottom, #f1f8fe, #d8e6f6);
|
||||
border: 1px solid #7da2ce;
|
||||
box-shadow: 0 1px 0 rgba(255, 255, 255, 0.7) inset;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
.description-toggle:hover {
|
||||
background-color: var(--primary-light);
|
||||
color: var(--text-inverse);
|
||||
}
|
||||
|
||||
.description-expanded {
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
.description-collapsed {
|
||||
white-space: nowrap;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
max-width: 250px;
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.commit-link {
|
||||
color: #2c5fb2;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.commit-link:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
/* File path styling */
|
||||
.file-path-container {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.file-path {
|
||||
display: inline-block;
|
||||
max-width: 100%;
|
||||
word-wrap: break-word;
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
.match-content {
|
||||
font-family: var(--font-mono);
|
||||
font-size: 0.875rem;
|
||||
word-break: break-all;
|
||||
white-space: pre-wrap;
|
||||
display: block;
|
||||
background-color: #f9f9f9;
|
||||
border: 1px solid #d0d0d0;
|
||||
border-radius: 3px;
|
||||
padding: 0.5rem;
|
||||
margin-top: 0.5rem;
|
||||
max-height: 300px;
|
||||
overflow-y: auto;
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
.app-header {
|
||||
padding: 0 1rem;
|
||||
}
|
||||
|
||||
.app-main {
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
.report-stats {
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.filters {
|
||||
flex-direction: column;
|
||||
gap: 0.75rem;
|
||||
}
|
||||
|
||||
.app-footer {
|
||||
flex-direction: column;
|
||||
height: auto;
|
||||
padding: 0.75rem 1rem;
|
||||
gap: 0.5rem;
|
||||
justify-content: center;
|
||||
text-align: center;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="app-container">
|
||||
<header class="app-header">
|
||||
<div class="logo">
|
||||
<h1>Gitleaks Security Findings</h1>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<main class="app-main">
|
||||
<div class="report-info">
|
||||
<h2>Security Scan Report</h2>
|
||||
<p class="report-date">Generated on {{now | date "Jan 02, 2006 15:04:05 MST"}}</p>
|
||||
|
||||
<div class="report-stats">
|
||||
<div class="stat-item">
|
||||
<span class="stat-value">{{len .}}</span>
|
||||
<span class="stat-label">Total Findings</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item">
|
||||
<span class="stat-value" id="filesCount">-</span>
|
||||
<span class="stat-label">Files Affected</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item">
|
||||
<span class="stat-value" id="rulesCount">-</span>
|
||||
<span class="stat-label">Unique Rules Triggered</span>
|
||||
</div>
|
||||
|
||||
<div class="stat-item" id="scanModeContainer">
|
||||
<span class="stat-value" id="scanMode">-</span>
|
||||
<span class="stat-label">Scan Mode</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="filters">
|
||||
<div class="filter-group">
|
||||
<label class="filter-label" for="filterRule">Filter by Rule:</label>
|
||||
<select class="filter-input" id="filterRule">
|
||||
<option value="all">All Rules</option>
|
||||
<!-- Rule options will be populated by JavaScript -->
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div class="filter-group">
|
||||
<label class="filter-label" for="filterFile">Filter by File:</label>
|
||||
<input type="text" class="filter-input" id="filterFile" placeholder="Enter filename...">
|
||||
</div>
|
||||
|
||||
<div class="filter-group">
|
||||
<button class="btn btn-primary btn-sm" id="resetFilters">Reset Filters</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="table-wrapper">
|
||||
<table class="findings-table" id="findingsTable">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Rule</th>
|
||||
<th>File</th>
|
||||
<th>Description</th>
|
||||
<th>Secret</th>
|
||||
<th>Metadata</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{{- range . }}
|
||||
<tr data-rule="{{.RuleID}}" data-file="{{.File}}">
|
||||
<td>{{.RuleID}}</td>
|
||||
<td>
|
||||
<div class="file-path-container">
|
||||
<span class="file-path" title="{{.File}}">{{.File}}</span>
|
||||
</div>
|
||||
<div class="tag-list">
|
||||
{{- range .Tags }}
|
||||
<span class="tag">{{.}}</span>
|
||||
{{- end}}
|
||||
</div>
|
||||
<div class="meta-row">
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Line:</span>
|
||||
<span class="meta-value">{{.StartLine}}</span>
|
||||
</div>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<span class="description-text">{{.Description}}</span>
|
||||
<span class="description-toggle" title="Expand/Collapse">↕</span>
|
||||
</td>
|
||||
<td>
|
||||
<div class="secret-container" data-secret="{{.Secret}}" data-match="{{.Match}}">
|
||||
<div class="secret-match">{{.Secret}}</div>
|
||||
<button type="button" class="match-toggle" title="Show/Hide Full Match Context">Show Context</button>
|
||||
<div class="match-content hidden" data-raw-match="{{.Match}}">{{.Match}}</div>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<div class="meta-row">
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Entropy:</span>
|
||||
<span class="meta-value">{{printf "%.2f" .Entropy}}</span>
|
||||
</div>
|
||||
{{- if .Commit}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Commit:</span>
|
||||
<span class="meta-value">{{if gt (len .Commit) 7}}{{printf "%.7s" .Commit}}{{else}}{{.Commit}}{{end}}</span>
|
||||
</div>
|
||||
{{- if .Author}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Author:</span>
|
||||
<span class="meta-value">{{.Author}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- if .Date}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Date:</span>
|
||||
<span class="meta-value">{{.Date}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- if .Link}}
|
||||
<div class="meta-item commit-info">
|
||||
<span class="meta-label">Link:</span>
|
||||
<span class="meta-value"><a href="{{.Link}}" target="_blank" class="commit-link">View Commit</a></span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- else}}
|
||||
{{- if .Author}}
|
||||
<div class="meta-item">
|
||||
<span class="meta-label">Author:</span>
|
||||
<span class="meta-value">{{.Author}}</span>
|
||||
</div>
|
||||
{{- end}}
|
||||
{{- end}}
|
||||
</div>
|
||||
|
||||
{{- if not .Match}}
|
||||
<div class="match-content" data-raw-match="">-</div>
|
||||
{{- end}}
|
||||
</td>
|
||||
</tr>
|
||||
{{- end }}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<footer class="app-footer">
|
||||
<div>Generated by Gitleaks</div>
|
||||
<div>Total Findings: <strong>{{len .}}</strong></div>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
// Process data to collect unique files and rules
|
||||
function processData() {
|
||||
const rows = document.querySelectorAll('#findingsTable tbody tr');
|
||||
const uniqueRules = new Set();
|
||||
const uniqueFiles = new Set();
|
||||
let isGitMode = false;
|
||||
|
||||
if (rows.length > 0) {
|
||||
// Check if first finding has commit data to determine mode
|
||||
const firstRow = rows[0];
|
||||
const commitCells = firstRow.querySelectorAll('.commit-info');
|
||||
isGitMode = commitCells.length > 0 && commitCells[0].textContent.trim() !== '';
|
||||
}
|
||||
|
||||
// Set scan mode
|
||||
document.getElementById('scanMode').textContent = isGitMode ? 'Git' : 'Directory';
|
||||
|
||||
// Adjust UI based on mode
|
||||
if (isGitMode) {
|
||||
// Ensure commit info columns are visible for git mode
|
||||
document.querySelectorAll('.commit-info').forEach(el => {
|
||||
el.style.display = 'block';
|
||||
});
|
||||
} else {
|
||||
// Hide commit-specific UI elements for directory mode
|
||||
document.querySelectorAll('.commit-info').forEach(el => {
|
||||
el.style.display = 'none';
|
||||
});
|
||||
}
|
||||
|
||||
rows.forEach(row => {
|
||||
uniqueRules.add(row.dataset.rule);
|
||||
uniqueFiles.add(row.dataset.file);
|
||||
});
|
||||
|
||||
// Update stats
|
||||
document.getElementById('filesCount').textContent = uniqueFiles.size;
|
||||
document.getElementById('rulesCount').textContent = uniqueRules.size;
|
||||
|
||||
// Populate rule filter dropdown
|
||||
const ruleFilter = document.getElementById('filterRule');
|
||||
const sortedRules = Array.from(uniqueRules).sort();
|
||||
sortedRules.forEach(rule => {
|
||||
const option = document.createElement('option');
|
||||
option.value = rule;
|
||||
option.textContent = rule;
|
||||
ruleFilter.appendChild(option);
|
||||
});
|
||||
}
|
||||
|
||||
// Hide toggle button if match is same as secret
|
||||
function hideRedundantToggleButtons() {
|
||||
document.querySelectorAll('.secret-container').forEach(container => {
|
||||
const secret = container.getAttribute('data-secret');
|
||||
const match = container.getAttribute('data-match');
|
||||
const toggleButton = container.querySelector('.match-toggle');
|
||||
|
||||
// If secret and match are the same, or if match is empty, hide the toggle button
|
||||
if ((secret && match && secret.trim() === match.trim()) || !match) {
|
||||
if (toggleButton) {
|
||||
toggleButton.style.display = 'none';
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Setup toggle buttons
|
||||
function setupToggleButtons() {
|
||||
document.querySelectorAll('.match-toggle').forEach(btn => {
|
||||
btn.addEventListener('click', function() {
|
||||
const matchContent = this.nextElementSibling;
|
||||
if (matchContent.classList.contains('hidden')) {
|
||||
matchContent.classList.remove('hidden');
|
||||
this.textContent = 'Hide Context';
|
||||
} else {
|
||||
matchContent.classList.add('hidden');
|
||||
this.textContent = 'Show Context';
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Setup description toggle
|
||||
document.querySelectorAll('.description-text').forEach(descriptionText => {
|
||||
const toggleBtn = descriptionText.nextElementSibling;
|
||||
if (!toggleBtn || !toggleBtn.classList.contains('description-toggle')) return;
|
||||
|
||||
// Initial state: collapsed
|
||||
descriptionText.classList.add('description-collapsed');
|
||||
|
||||
toggleBtn.addEventListener('click', () => {
|
||||
if (descriptionText.classList.contains('description-collapsed')) {
|
||||
descriptionText.classList.remove('description-collapsed');
|
||||
descriptionText.classList.add('description-expanded');
|
||||
toggleBtn.textContent = '↑';
|
||||
} else {
|
||||
descriptionText.classList.remove('description-expanded');
|
||||
descriptionText.classList.add('description-collapsed');
|
||||
toggleBtn.textContent = '↕';
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// Filter functionality
|
||||
function applyFilters() {
|
||||
const ruleFilter = document.getElementById('filterRule').value;
|
||||
const fileFilter = document.getElementById('filterFile').value.toLowerCase();
|
||||
|
||||
const rows = document.querySelectorAll('#findingsTable tbody tr');
|
||||
|
||||
rows.forEach(row => {
|
||||
const ruleMatch = ruleFilter === 'all' || row.dataset.rule === ruleFilter;
|
||||
const fileMatch = fileFilter === '' || row.dataset.file.toLowerCase().includes(fileFilter);
|
||||
|
||||
if (ruleMatch && fileMatch) {
|
||||
row.style.display = '';
|
||||
} else {
|
||||
row.style.display = 'none';
|
||||
}
|
||||
});
|
||||
|
||||
// Update visible count
|
||||
const visibleFindings = document.querySelectorAll('#findingsTable tbody tr:not([style*="display: none"])').length;
|
||||
document.querySelector('.app-footer strong').textContent = visibleFindings;
|
||||
}
|
||||
|
||||
document.getElementById('filterRule').addEventListener('change', applyFilters);
|
||||
document.getElementById('filterFile').addEventListener('input', applyFilters);
|
||||
document.getElementById('resetFilters').addEventListener('click', function() {
|
||||
document.getElementById('filterRule').value = 'all';
|
||||
document.getElementById('filterFile').value = '';
|
||||
applyFilters();
|
||||
});
|
||||
|
||||
// Initialize
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
processData();
|
||||
hideRedundantToggleButtons(); // Hide toggle buttons for matching secrets
|
||||
setupToggleButtons();
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
Loading…
x
Reference in New Issue
Block a user