Compare commits
7 commits
9c22913cec
...
main
Author | SHA1 | Date | |
---|---|---|---|
d3965e903a | |||
6dc0cd6d16 | |||
2236d7fec8 | |||
846c679353 | |||
87f20b7e05 | |||
96728de273 | |||
e6732ad8ad |
3 changed files with 885 additions and 245 deletions
622
LICENSE
Normal file
622
LICENSE
Normal file
|
@ -0,0 +1,622 @@
|
||||||
|
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
|
||||||
|
|
|
@ -158,7 +158,7 @@ Additional configuration options with their default values:
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
* `PICKER` \
|
* `PICKER_BACKEND` \
|
||||||
sets the tool to be used as interactive menu.
|
sets the tool to be used as interactive menu.
|
||||||
|
|
||||||
Can be used either to prefer an alternative to one of the default pickers for the program (`bemenu`, `rofi`, `dmenu`) if multiple are installed. Can also be used to invoke a completely different picker program whose functionality needs to mimic `dmenu` in that it takes its arguments trough `stdin`.
|
Can be used either to prefer an alternative to one of the default pickers for the program (`bemenu`, `rofi`, `dmenu`) if multiple are installed. Can also be used to invoke a completely different picker program whose functionality needs to mimic `dmenu` in that it takes its arguments trough `stdin`.
|
||||||
|
|
506
pass-pick
Normal file → Executable file
506
pass-pick
Normal file → Executable file
|
@ -1,5 +1,22 @@
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
#
|
#
|
||||||
|
# pass-pick - pick a password from your store
|
||||||
|
#
|
||||||
|
# Copyright (C) 2021 Marty Oehme
|
||||||
|
|
||||||
|
# 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/>.
|
||||||
|
|
||||||
# Pass picker
|
# Pass picker
|
||||||
#
|
#
|
||||||
# Use a dmenu-like list selector to display and autofill your pass passwords.
|
# Use a dmenu-like list selector to display and autofill your pass passwords.
|
||||||
|
@ -40,141 +57,137 @@
|
||||||
# Passes along any options given to main script.
|
# Passes along any options given to main script.
|
||||||
rofi_opts=("$@")
|
rofi_opts=("$@")
|
||||||
_picker() {
|
_picker() {
|
||||||
if [ -n "$PICKER" ]; then
|
if [ -n "$PICKER_BACKEND" ]; then
|
||||||
"${PICKER[@]}"
|
"${PICKER_BACKEND[@]}"
|
||||||
elif command -v rofi 1>/dev/null 2>/dev/null; then
|
elif command -v rofi 1>/dev/null 2>/dev/null; then
|
||||||
rofi -dmenu -no-auto-select -i "${rofi_opts[@]}" "$@" -p "entry"
|
rofi -dmenu -no-auto-select -i "${rofi_opts[@]}" -p "entry"
|
||||||
elif command -v bemenu 1>/dev/null 2>/dev/null; then
|
elif command -v bemenu 1>/dev/null 2>/dev/null; then
|
||||||
bemenu -l 20 -i -p "entry >"
|
bemenu -l 20 -i "${rofi_opts[@]}" -p "entry >"
|
||||||
elif command -v dmenu 1>/dev/null 2>/dev/null; then
|
elif command -v dmenu 1>/dev/null 2>/dev/null; then
|
||||||
dmenu -i -p "entry >"
|
dmenu -i "${rofi_opts[@]}" -p "entry >"
|
||||||
else
|
else
|
||||||
printf "%s: 📦 %s must be installed for %s function.\n" "critical" "rofi/bemenu/dmenu" "this" >&2
|
printf "%s: 📦 %s must be installed for %s function.\n" "critical" "rofi/bemenu/dmenu" "this" >&2
|
||||||
notify-send "📦 rofi/bemenu/dmenu" --urgency="critical" "must be installed for this function."
|
notify-send "📦 rofi/bemenu/dmenu" --urgency="critical" "must be installed for this function."
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
}
|
||||||
|
# copies to clipboard, removes any trailing newlines,
|
||||||
|
# and only keeps it in for 1 paste (1 loop to read in script, 1 to output)
|
||||||
|
_clipper() {
|
||||||
|
if command -v wl-copy 1>/dev/null 2>/dev/null; then
|
||||||
|
wl-copy -o -n
|
||||||
|
elif command -v xclip 1>/dev/null 2>/dev/null; then
|
||||||
|
xclip -i -selection 'clipboard' -loops 2 -rmlastnl
|
||||||
|
elif command -v xsel 1>/dev/null 2>/dev/null; then
|
||||||
|
xsel -b
|
||||||
|
else
|
||||||
|
notify-send "No clipboard utility" "Install wl-copy, xclip or xsel."
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# parse, see https://unix.stackexchange.com/a/331965/8541
|
# parse, see https://unix.stackexchange.com/a/331965/8541
|
||||||
_parse_config() {
|
_parse_config() {
|
||||||
(grep -e "^$2=" -m 1 "$1" 2>/dev/null || printf "var=__UNDEFINED__\n") | head -n1 | cut -d '=' -f 2-
|
(grep -e "^$2=" -m 1 "$1" 2>/dev/null || printf "var=__UNDEFINED__\n") | head -n1 | cut -d '=' -f 2-
|
||||||
}
|
}
|
||||||
|
|
||||||
# read config file
|
# read config file
|
||||||
get_config() {
|
get_config() {
|
||||||
local locations=(
|
local locations=(
|
||||||
"$PP_CONFIGURATION_FILE"
|
"$PP_CONFIGURATION_FILE"
|
||||||
"${xdg_config_home:-$HOME/.config}/pass-picker/pass-picker.conf"
|
"${xdg_config_home:-$HOME/.config}/pass-picker/pass-picker.conf"
|
||||||
"$HOME/.pass-picker.conf"
|
"$HOME/.pass-picker.conf"
|
||||||
"/etc/pass-picker.conf"
|
"/etc/pass-picker.conf"
|
||||||
)
|
)
|
||||||
|
|
||||||
# return the first config file with a valid path
|
# return the first config file with a valid path
|
||||||
for config in "${locations[@]}"; do
|
for config in "${locations[@]}"; do
|
||||||
if [[ -n "$config" && -f "$config" ]]; then
|
if [[ -n $config && -f $config ]]; then
|
||||||
# see if the config has been given a value
|
# see if the config has been given a value
|
||||||
local val
|
local val
|
||||||
val="$(_parse_config "$config" "$1")"
|
val="$(_parse_config "$config" "$1")"
|
||||||
break
|
break
|
||||||
fi
|
fi
|
||||||
done
|
done
|
||||||
|
|
||||||
# if there was a config file but no value
|
# if there was a config file but no value
|
||||||
# or there was no config file at all
|
# or there was no config file at all
|
||||||
if [ "$val" = "__UNDEFINED__" ] || [ -z "$val" ]; then
|
if [ "$val" = "__UNDEFINED__" ] || [ -z "$val" ]; then
|
||||||
val="$2"
|
val="$2"
|
||||||
fi
|
fi
|
||||||
printf -- "%s" "$val"
|
printf -- "%s" "$val"
|
||||||
}
|
}
|
||||||
|
|
||||||
set_defaults() {
|
set_defaults() {
|
||||||
# The location of the pass-picker config file
|
# The location of the pass-picker config file
|
||||||
# PP_CONFIGURATION_FILE="~/.config/pass-picker/pass-picker.conf"
|
# PP_CONFIGURATION_FILE="~/.config/pass-picker/pass-picker.conf"
|
||||||
# set options, leaving already set environment variables intact
|
# set options, leaving already set environment variables intact
|
||||||
# try to read any settings from config files
|
# try to read any settings from config files
|
||||||
PICKER="${PP_PICKER:-$(get_config PICKER)}"
|
PICKER_BACKEND="${PP_PICKER_BACKEND:-$(get_config PICKER_BACKEND)}"
|
||||||
|
|
||||||
KEY_AUTOFILL="${PP_KEY_AUTOFILL:-$(get_config KEY_AUTOFILL Return)}"
|
KEY_AUTOFILL="${PP_KEY_AUTOFILL:-$(get_config KEY_AUTOFILL Return)}"
|
||||||
KEY_ENTRY_OPEN="${PP_KEY_ENTRY_OPEN:-$(get_config KEY_ENTRY_OPEN Alt+Return)}"
|
KEY_ENTRY_OPEN="${PP_KEY_ENTRY_OPEN:-$(get_config KEY_ENTRY_OPEN Alt+Return)}"
|
||||||
KEY_FILL_USER="${PP_KEY_FILL_USER:-$(get_config KEY_FILL_USER Alt+u)}"
|
KEY_FILL_USER="${PP_KEY_FILL_USER:-$(get_config KEY_FILL_USER Alt+u)}"
|
||||||
KEY_CLIP_USER="${PP_KEY_CLIP_USER:-$(get_config KEY_CLIP_USER Ctrl+Alt+u)}"
|
KEY_CLIP_USER="${PP_KEY_CLIP_USER:-$(get_config KEY_CLIP_USER Ctrl+Alt+u)}"
|
||||||
KEY_FILL_PASS="${PP_KEY_FILL_PASS:-$(get_config KEY_FILL_PASS Alt+p)}"
|
KEY_FILL_PASS="${PP_KEY_FILL_PASS:-$(get_config KEY_FILL_PASS Alt+p)}"
|
||||||
KEY_CLIP_PASS="${PP_KEY_CLIP_PASS:-$(get_config KEY_CLIP_PASS Ctrl+Alt+p)}"
|
KEY_CLIP_PASS="${PP_KEY_CLIP_PASS:-$(get_config KEY_CLIP_PASS Ctrl+Alt+p)}"
|
||||||
KEY_ENTRYMENU_FILL="${PP_KEY_ENTRYMENU_FILL:-$(get_config KEY_ENTRYMENU_FILL Return)}"
|
KEY_ENTRYMENU_FILL="${PP_KEY_ENTRYMENU_FILL:-$(get_config KEY_ENTRYMENU_FILL Return)}"
|
||||||
KEY_ENTRYMENU_CLIP="${PP_KEY_ENTRYMENU_CLIP:-$(get_config KEY_ENTRYMENU_CLIP Alt+Return)}"
|
KEY_ENTRYMENU_CLIP="${PP_KEY_ENTRYMENU_CLIP:-$(get_config KEY_ENTRYMENU_CLIP Alt+Return)}"
|
||||||
KEY_ENTRYMENU_SHOWFIELD="${KEY_ENTRYMENU_SHOWFIELD:-$(get_config KEY_ENTRYMENU_SHOWFIELD Alt+s)}"
|
KEY_ENTRYMENU_SHOWFIELD="${KEY_ENTRYMENU_SHOWFIELD:-$(get_config KEY_ENTRYMENU_SHOWFIELD Alt+s)}"
|
||||||
KEY_ENTRYMENU_QUIT="${PP_KEY_ENTRYMENU_QUIT:-$(get_config KEY_ENTRYMENU_QUIT Alt+BackSpace)}"
|
KEY_ENTRYMENU_QUIT="${PP_KEY_ENTRYMENU_QUIT:-$(get_config KEY_ENTRYMENU_QUIT Alt+BackSpace)}"
|
||||||
|
|
||||||
AUTOFILL_BACKEND="${PP_AUTOFILL_BACKEND:-$(get_config AUTOFILL_BACKEND wtype)}"
|
AUTOFILL_BACKEND="${PP_AUTOFILL_BACKEND:-$(get_config AUTOFILL_BACKEND wtype)}"
|
||||||
AUTOFILL_CHAIN="${PP_AUTOENTRY_CHAIN:-$(get_config AUTOFILL_CHAIN 'username :tab password')}"
|
AUTOFILL_CHAIN="${PP_AUTOENTRY_CHAIN:-$(get_config AUTOFILL_CHAIN 'username :tab password')}"
|
||||||
AUTOFILL_DELAY="${PP_AUTOENTRY_DELAY:-$(get_config AUTOFILL_DELAY 30)}"
|
AUTOFILL_DELAY="${PP_AUTOENTRY_DELAY:-$(get_config AUTOFILL_DELAY 30)}"
|
||||||
|
|
||||||
PASS_USERNAME_FIELD="${PP_PASS_USERNAME_FIELD:-$(get_config PASS_USERNAME_FIELD 'username user login')}"
|
PASS_USERNAME_FIELD="${PP_PASS_USERNAME_FIELD:-$(get_config PASS_USERNAME_FIELD 'username user login')}"
|
||||||
PASS_COFFIN_OPEN_TIME="${PP_PASS_COFFIN_OPEN_TIME:-$(get_config PASS_COFFIN_OPEN_TIME 0)}"
|
PASS_COFFIN_OPEN_TIME="${PP_PASS_COFFIN_OPEN_TIME:-$(get_config PASS_COFFIN_OPEN_TIME 0)}"
|
||||||
PASS_COFFIN_LOCATION="${PP_PASS_COFFIN_LOCATION:-$(get_config PASS_COFFIN_LOCATION)}"
|
PASS_COFFIN_LOCATION="${PP_PASS_COFFIN_LOCATION:-$(get_config PASS_COFFIN_LOCATION)}"
|
||||||
}
|
}
|
||||||
|
|
||||||
# exit on escape pressed
|
# exit on escape pressed
|
||||||
exit_check() {
|
exit_check() {
|
||||||
[ "$1" -eq 1 ] && exit
|
[ "$1" -eq 1 ] && exit
|
||||||
}
|
}
|
||||||
|
|
||||||
# simply return a list of all passwords in pass store
|
# simply return a list of all passwords in pass store
|
||||||
# TODO only show website names (+ folder names), and account names for multiple accounts on one site
|
# TODO only show website names (+ folder names), and account names for multiple accounts on one site
|
||||||
list_passwords() {
|
list_passwords() {
|
||||||
shopt -s nullglob globstar
|
shopt -s nullglob globstar
|
||||||
prefix=${PASSWORD_STORE_DIR:-~/.password-store}
|
prefix=${PASSWORD_STORE_DIR:-~/.password-store}
|
||||||
password_files=("$prefix"/**/*.gpg)
|
password_files=("$prefix"/**/*.gpg)
|
||||||
password_files=("${password_files[@]#"$prefix"/}")
|
password_files=("${password_files[@]#"$prefix"/}")
|
||||||
password_files=("${password_files[@]%.gpg}")
|
password_files=("${password_files[@]%.gpg}")
|
||||||
|
|
||||||
printf '%s\n' "${password_files[@]}"
|
printf '%s\n' "${password_files[@]}"
|
||||||
}
|
}
|
||||||
|
|
||||||
# return password for argument passed
|
# return password for argument passed
|
||||||
show_password() {
|
show_password() {
|
||||||
pass show "$1" | head -n1
|
pass show "$1" | head -n1
|
||||||
}
|
}
|
||||||
|
|
||||||
# send password to clipboard
|
# send password to clipboard
|
||||||
clip_password() {
|
clip_password() {
|
||||||
pass show -c "$1"
|
pass show -c "$1"
|
||||||
}
|
}
|
||||||
|
|
||||||
# attempt to return the field specified
|
# attempt to return the field specified
|
||||||
# attempts all (space separated) fields until the
|
# attempts all (space separated) fields until the
|
||||||
# first one successfully returned
|
# first one successfully returned
|
||||||
_p_get_field() {
|
_p_get_field() {
|
||||||
local gp_entry="$1"
|
local gp_entry="$1"
|
||||||
local gp_field="$2"
|
local gp_field="$2"
|
||||||
local clip="$3"
|
|
||||||
|
|
||||||
# return on first successfully returned key
|
# return on first successfully returned key
|
||||||
for key in $gp_field; do
|
for key in $gp_field; do
|
||||||
local value
|
local value
|
||||||
value=$(_p_get_key_value "$gp_entry" "$key")
|
value=$(_p_get_key_value "$gp_entry" "$key")
|
||||||
|
|
||||||
# found entry
|
# found entry
|
||||||
if [ -n "$value" ]; then
|
if [ -n "$value" ]; then
|
||||||
|
echo "$value" && break
|
||||||
if [ -n "$clip" ]; then
|
fi
|
||||||
# copies to clipboard, removes any trailing newlines,
|
done
|
||||||
# and only keeps it in for 1 paste (1 loop to read in script, 1 to output)
|
|
||||||
if command -v wl-copy; then
|
|
||||||
echo "$value" | wl-copy -o && break
|
|
||||||
elif command -v xclip; then
|
|
||||||
echo "$value" | xclip -i -selection 'clipboard' -loops 2 -rmlastnl && break
|
|
||||||
elif command -v xsel; then
|
|
||||||
echo "$value" | xsel -b && break
|
|
||||||
else
|
|
||||||
notify-send "No clipboard utility" "Install wl-copy, xclip or xsel."
|
|
||||||
fi
|
|
||||||
else
|
|
||||||
echo "$value" && break
|
|
||||||
fi
|
|
||||||
|
|
||||||
fi
|
|
||||||
done
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# returns the corresponding value for the key passed in
|
# returns the corresponding value for the key passed in
|
||||||
|
@ -182,208 +195,213 @@ _p_get_field() {
|
||||||
# $1: pass (file) entry to search through
|
# $1: pass (file) entry to search through
|
||||||
# $2: string name of the containting key
|
# $2: string name of the containting key
|
||||||
_p_get_key_value() {
|
_p_get_key_value() {
|
||||||
local value
|
local value
|
||||||
value=$(list_fields "$1" | grep "$2")
|
value=$(list_fields "$1" | grep "$2")
|
||||||
|
|
||||||
# get everything after first colon, remove whitespace
|
# get everything after first colon, remove whitespace
|
||||||
echo "$value" | cut -d':' -f2- | tr -d '[:blank:]'
|
echo "$value" | cut -d':' -f2- | tr -d '[:blank:]'
|
||||||
}
|
}
|
||||||
|
|
||||||
# return username for argument passed
|
# return username for argument passed
|
||||||
|
# Prefers in-metadata username, falls back to filename
|
||||||
show_username() {
|
show_username() {
|
||||||
_p_get_field "$1" "${PASS_USERNAME_FIELD}"
|
result=$(_p_get_field "$1" "${PASS_USERNAME_FIELD}")
|
||||||
|
if [ -z "$result" ]; then
|
||||||
|
echo "${1##*/}"
|
||||||
|
else
|
||||||
|
echo "$result"
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
clip_username() {
|
clip_username() {
|
||||||
_p_get_field "$1" "${PASS_USERNAME_FIELD}" "-c"
|
show_username "$1" "${PASS_USERNAME_FIELD}" | _clipper
|
||||||
}
|
}
|
||||||
|
|
||||||
show_field() {
|
show_field() {
|
||||||
_p_get_field "$1" "$2"
|
_p_get_field "$1" "$2"
|
||||||
}
|
}
|
||||||
|
|
||||||
clip_field() {
|
clip_field() {
|
||||||
_p_get_field "$1" "$2" "-c"
|
show_field "$1" "$2" | _clipper
|
||||||
}
|
}
|
||||||
|
|
||||||
list_fields() {
|
list_fields() {
|
||||||
pass show "$1" | tail -n+2
|
pass show "$1" | tail -n+2
|
||||||
}
|
}
|
||||||
|
|
||||||
# invoke the dotool to type inputs
|
# invoke the dotool to type inputs
|
||||||
_type() {
|
_type() {
|
||||||
local tool="${AUTOFILL_BACKEND}"
|
local tool="${AUTOFILL_BACKEND}"
|
||||||
local toolmode="$1"
|
local toolmode="$1"
|
||||||
local key="$2"
|
local key="$2"
|
||||||
|
|
||||||
if [ "$tool" = "wtype" ]; then
|
if [ "$tool" = "wtype" ]; then
|
||||||
if [ "$toolmode" = "type" ]; then
|
if [ "$toolmode" = "type" ]; then
|
||||||
"$tool" -s "${AUTOFILL_DELAY}" -- "$key"
|
"$tool" -s "${AUTOFILL_DELAY}" -- "$key"
|
||||||
elif [ "$toolmode" = "key" ]; then
|
elif [ "$toolmode" = "key" ]; then
|
||||||
"$tool" -s "${AUTOFILL_DELAY}" -k "$key"
|
"$tool" -s "${AUTOFILL_DELAY}" -k "$key"
|
||||||
fi
|
fi
|
||||||
elif [ "$tool" = "xdotool" ]; then
|
elif [ "$tool" = "xdotool" ]; then
|
||||||
"$tool" "$toolmode" --delay "${AUTOFILL_DELAY}" "$key"
|
"$tool" "$toolmode" --delay "${AUTOFILL_DELAY}" "$key"
|
||||||
elif [ "$tool" = "ydotool" ]; then
|
elif [ "$tool" = "ydotool" ]; then
|
||||||
"$tool" "$toolmode" --key-delay "${AUTOFILL_DELAY}" "$key"
|
"$tool" "$toolmode" --key-delay "${AUTOFILL_DELAY}" "$key"
|
||||||
else
|
else
|
||||||
"$tool" "$toolmode" "$key"
|
"$tool" "$toolmode" "$key"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# automatically fill out fields
|
# automatically fill out fields
|
||||||
# transform special chain entries into valid dotool commands
|
# transform special chain entries into valid dotool commands
|
||||||
autofill() {
|
autofill() {
|
||||||
local selected="${1}"
|
local selected="${1}"
|
||||||
local autoentry_chain="${2}"
|
local autoentry_chain="${2}"
|
||||||
|
|
||||||
for part in $autoentry_chain; do
|
for part in $autoentry_chain; do
|
||||||
case "$part" in
|
case "$part" in
|
||||||
":tab") _type key Tab ;;
|
":tab") _type key Tab ;;
|
||||||
":return") _type key Return ;;
|
":return") _type key Return ;;
|
||||||
":space") _type key space ;;
|
":space") _type key space ;;
|
||||||
"username") _type type "$(show_username "$selected")" ;;
|
"username") _type type "$(show_username "$selected")" ;;
|
||||||
"password") _type type "$(show_password "$selected")" ;;
|
"password") _type type "$(show_password "$selected")" ;;
|
||||||
":direct") _type type "$selected" ;;
|
":direct") _type type "$selected" ;;
|
||||||
*) printf '%s' "$selected" ;;
|
*) printf '%s' "$selected" ;;
|
||||||
esac
|
esac
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
# opens a menu for the specified pass entry, containing its individual fields
|
# opens a menu for the specified pass entry, containing its individual fields
|
||||||
entrymenu() {
|
entrymenu() {
|
||||||
local entry="$1"
|
local entry="$1"
|
||||||
local deobfuscate="$2"
|
local deobfuscate="$2"
|
||||||
local k_entrymenu_fill="${KEY_ENTRYMENU_FILL}"
|
local k_entrymenu_fill="${KEY_ENTRYMENU_FILL}"
|
||||||
local k_entrymenu_clip="${KEY_ENTRYMENU_CLIP}"
|
local k_entrymenu_clip="${KEY_ENTRYMENU_CLIP}"
|
||||||
local k_entrymenu_showfield="${KEY_ENTRYMENU_SHOWFIELD}"
|
local k_entrymenu_showfield="${KEY_ENTRYMENU_SHOWFIELD}"
|
||||||
local k_entrymenu_quit="${KEY_ENTRYMENU_QUIT}"
|
local k_entrymenu_quit="${KEY_ENTRYMENU_QUIT}"
|
||||||
|
|
||||||
local pass
|
local pass
|
||||||
if [ "$deobfuscate" = "true" ]; then
|
if [ "$deobfuscate" = "true" ]; then
|
||||||
pass="$(show_password "$entry")"
|
pass="$(show_password "$entry")"
|
||||||
else
|
else
|
||||||
pass="(hidden)"
|
pass="(hidden)"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
local field
|
local field
|
||||||
field=$(
|
field=$(
|
||||||
printf "password: %s\n%s" "$pass" "$(list_fields "$entry")" |
|
printf "password: %s\n%s" "$pass" "$(list_fields "$entry")" \
|
||||||
_picker \
|
| _picker \
|
||||||
-kb-accept-entry "" \
|
-kb-accept-entry "" \
|
||||||
-kb-custom-1 "$k_entrymenu_fill" \
|
-kb-custom-1 "$k_entrymenu_fill" \
|
||||||
-kb-custom-2 "$k_entrymenu_clip" \
|
-kb-custom-2 "$k_entrymenu_clip" \
|
||||||
-kb-custom-3 "$k_entrymenu_quit" \
|
-kb-custom-3 "$k_entrymenu_quit" \
|
||||||
-kb-custom-4 "$k_entrymenu_showfield" \
|
-kb-custom-4 "$k_entrymenu_showfield" \
|
||||||
-mesg " ᐊ $k_entrymenu_quit ᐊ | $k_entrymenu_fill: fill selection | $k_entrymenu_clip: clip selection | $k_entrymenu_showfield: reveal password"
|
-mesg " ᐊ $k_entrymenu_quit ᐊ | $k_entrymenu_fill: fill selection | $k_entrymenu_clip: clip selection | $k_entrymenu_showfield: reveal password"
|
||||||
)
|
)
|
||||||
exit_value=$?
|
exit_value=$?
|
||||||
exit_check "$exit_value"
|
exit_check "$exit_value"
|
||||||
|
|
||||||
# get field name
|
# get field name
|
||||||
field=${field%%:*}
|
field=${field%%:*}
|
||||||
case "$exit_value" in
|
case "$exit_value" in
|
||||||
"0" | "10")
|
"0" | "10")
|
||||||
if [ "$field" = "password" ]; then
|
if [ "$field" = "password" ]; then
|
||||||
autofill "$entry" "password"
|
autofill "$entry" "password"
|
||||||
else
|
else
|
||||||
autofill "$(show_field "$entry" "$field")" ":direct"
|
autofill "$(show_field "$entry" "$field")" ":direct"
|
||||||
fi
|
fi
|
||||||
exit 0
|
exit 0
|
||||||
;;
|
;;
|
||||||
"11")
|
"11")
|
||||||
if [ "$field" = "password" ]; then
|
if [ "$field" = "password" ]; then
|
||||||
clip_password "$entry"
|
clip_password "$entry"
|
||||||
else
|
else
|
||||||
clip_field "$entry" "$field"
|
clip_field "$entry" "$field"
|
||||||
fi
|
fi
|
||||||
exit 0
|
exit 0
|
||||||
;;
|
;;
|
||||||
"12")
|
"12")
|
||||||
main
|
main
|
||||||
;;
|
;;
|
||||||
"13")
|
"13")
|
||||||
local toggle
|
local toggle
|
||||||
if [ "$deobfuscate" = "true" ]; then
|
if [ "$deobfuscate" = "true" ]; then
|
||||||
toggle=false
|
toggle=false
|
||||||
else
|
else
|
||||||
toggle=true
|
toggle=true
|
||||||
fi
|
fi
|
||||||
entrymenu "$entry" "$toggle"
|
entrymenu "$entry" "$toggle"
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
}
|
}
|
||||||
|
|
||||||
open_coffin() {
|
open_coffin() {
|
||||||
## there's a closed coffin in our directory
|
## there's a closed coffin in our directory
|
||||||
if [ -f "${PASS_COFFIN_LOCATION:-${PASSWORD_STORE_DIR:-~/.password-store}/.coffin/coffin.tar.gpg}" ]; then
|
if [ -f "${PASS_COFFIN_LOCATION:-${PASSWORD_STORE_DIR:-~/.password-store}/.coffin/coffin.tar.gpg}" ]; then
|
||||||
if [ "$PASS_COFFIN_OPEN_TIME" -eq 0 ]; then
|
if [ "$PASS_COFFIN_OPEN_TIME" -eq 0 ]; then
|
||||||
coffin_should_close_instantly=true
|
coffin_should_close_instantly=true
|
||||||
pass open -t 1h # we still set a maximum time limit just to hedge against failures
|
pass open -t 1h # we still set a maximum time limit just to hedge against failures
|
||||||
else
|
else
|
||||||
pass open -t "${PASS_COFFIN_OPEN_TIME:-3h}"
|
pass open -t "${PASS_COFFIN_OPEN_TIME:-3h}"
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# make sure we remember to close the coffin if the program terminates
|
# make sure we remember to close the coffin if the program terminates
|
||||||
close_coffin() {
|
close_coffin() {
|
||||||
if [ "$coffin_should_close_instantly" = true ]; then
|
if [ "$coffin_should_close_instantly" = true ]; then
|
||||||
pass close
|
pass close
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
trap close_coffin SIGINT SIGTERM ERR EXIT
|
trap close_coffin SIGINT SIGTERM ERR EXIT
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
local autoentry_chain="${AUTOFILL_CHAIN}"
|
local autoentry_chain="${AUTOFILL_CHAIN}"
|
||||||
local k_autofill="${KEY_AUTOFILL}"
|
local k_autofill="${KEY_AUTOFILL}"
|
||||||
local k_fill_user="${KEY_FILL_USER}"
|
local k_fill_user="${KEY_FILL_USER}"
|
||||||
local k_clip_user="${KEY_CLIP_USER}"
|
local k_clip_user="${KEY_CLIP_USER}"
|
||||||
local k_fill_pass="${KEY_FILL_PASS}"
|
local k_fill_pass="${KEY_FILL_PASS}"
|
||||||
local k_clip_pass="${KEY_CLIP_PASS}"
|
local k_clip_pass="${KEY_CLIP_PASS}"
|
||||||
local k_submenu="${KEY_ENTRY_OPEN}"
|
local k_submenu="${KEY_ENTRY_OPEN}"
|
||||||
|
|
||||||
open_coffin
|
open_coffin
|
||||||
|
|
||||||
entry="$(
|
entry="$(
|
||||||
list_passwords |
|
list_passwords \
|
||||||
_picker -kb-accept-entry "" \
|
| _picker -kb-accept-entry "" \
|
||||||
-kb-custom-1 "$k_autofill" \
|
-kb-custom-1 "$k_autofill" \
|
||||||
-kb-custom-2 "$k_clip_user" \
|
-kb-custom-2 "$k_clip_user" \
|
||||||
-kb-custom-3 "$k_clip_pass" \
|
-kb-custom-3 "$k_clip_pass" \
|
||||||
-kb-custom-4 "$k_fill_user" \
|
-kb-custom-4 "$k_fill_user" \
|
||||||
-kb-custom-5 "$k_fill_pass" \
|
-kb-custom-5 "$k_fill_pass" \
|
||||||
-kb-custom-6 "$k_submenu" \
|
-kb-custom-6 "$k_submenu" \
|
||||||
-mesg "| $k_autofill: fill credentials | $k_submenu: open entry | $k_fill_user: fill username | $k_fill_pass: fill password | $k_clip_user: clip username | $k_clip_pass: clip password |"
|
-mesg "| $k_autofill: fill credentials | $k_submenu: open entry | $k_fill_user: fill username | $k_fill_pass: fill password | $k_clip_user: clip username | $k_clip_pass: clip password |"
|
||||||
)"
|
)"
|
||||||
exit_value=$?
|
exit_value=$?
|
||||||
|
|
||||||
echo "$entry"
|
echo "$entry"
|
||||||
exit_check "$exit_value"
|
exit_check "$exit_value"
|
||||||
case "$exit_value" in
|
case "$exit_value" in
|
||||||
"0" | "10")
|
"0" | "10")
|
||||||
autofill "$entry" "$autoentry_chain"
|
autofill "$entry" "$autoentry_chain"
|
||||||
;;
|
;;
|
||||||
"11")
|
"11")
|
||||||
clip_username "$entry"
|
clip_username "$entry"
|
||||||
;;
|
;;
|
||||||
"12")
|
"12")
|
||||||
clip_password "$entry"
|
clip_password "$entry"
|
||||||
;;
|
;;
|
||||||
"13")
|
"13")
|
||||||
autofill "$entry" "username"
|
autofill "$entry" "username"
|
||||||
;;
|
;;
|
||||||
"14")
|
"14")
|
||||||
autofill "$entry" "password"
|
autofill "$entry" "password"
|
||||||
;;
|
;;
|
||||||
"15")
|
"15")
|
||||||
entrymenu "$entry"
|
entrymenu "$entry"
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
exit 0
|
exit 0
|
||||||
}
|
}
|
||||||
|
|
||||||
set_defaults
|
set_defaults
|
||||||
main
|
main
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue