v0.2.0
This commit is contained in:
commit
f936aeb807
118 changed files with 15710 additions and 0 deletions
33
AGENTS.md
Normal file
33
AGENTS.md
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
# AGENT INSTRUCTIONS
|
||||
|
||||
This repository contains the WordPress plugin **2FA (by ROBOTSTXT)**. Follow these rules whenever you work on any file within this repository:
|
||||
|
||||
1. **Language**
|
||||
- Write every piece of documentation, copy, and code comments in English.
|
||||
|
||||
2. **Code standards**
|
||||
- All PHP code must comply with **PHPCS** and **WPCS**.
|
||||
- Use tabs for indentation (no spaces).
|
||||
- Ensure compatibility with **PHP 8.2** or higher.
|
||||
- Provide proper **PHPDoc** annotations for classes, properties, and methods.
|
||||
|
||||
3. **WordPress security**
|
||||
- Sanitize, validate, and escape all user-provided data.
|
||||
- Include nonces in forms and verify them before processing submissions.
|
||||
- Do not suppress validation or authentication errors.
|
||||
|
||||
4. **Plugin structure**
|
||||
- Keep the code modular inside the `includes/` directory.
|
||||
- Place admin-related logic in subdirectories under `includes/admin/`.
|
||||
- Store presentational templates in `templates/`.
|
||||
- Whenever new persistent data (options, tables, user meta, etc.) is introduced, update `uninstall.php` so the plugin removes it on uninstall.
|
||||
|
||||
5. **Testing and tooling**
|
||||
- Run all available checks (PHPCS, PHPUnit, etc.) after making changes.
|
||||
- Summarize the commands executed and their results in the final message.
|
||||
|
||||
6. **Documentation**
|
||||
- Update `readme.txt` and `changelog.txt` whenever functional changes are introduced.
|
||||
- Explain *why* when the reason for a piece of code is not obvious.
|
||||
|
||||
These instructions apply to the entire repository tree.
|
||||
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>.
|
||||
2
README.md
Normal file
2
README.md
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
# robotstxt-2fa
|
||||
Simple 2FA WordPress plugin
|
||||
44
assets/css/profile.css
Normal file
44
assets/css/profile.css
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
.robotstxt-2fa-method-list {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
|
||||
.robotstxt-2fa-method {
|
||||
margin-bottom: 1.5em;
|
||||
}
|
||||
|
||||
.robotstxt-2fa-method:last-of-type {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
.robotstxt-2fa-otp-qr {
|
||||
height: auto;
|
||||
max-width: 220px;
|
||||
}
|
||||
|
||||
.robotstxt-2fa-recovery-code-grid {
|
||||
display: grid;
|
||||
gap: 8px 16px;
|
||||
grid-template-columns: repeat(2, minmax(140px, 1fr));
|
||||
}
|
||||
|
||||
.robotstxt-2fa-recovery-code-row {
|
||||
display: contents;
|
||||
}
|
||||
|
||||
.robotstxt-2fa-recovery-code-item {
|
||||
font-size: 1.2em;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.robotstxt-2fa-recovery-confirm {
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
.robotstxt-2fa-recovery-confirm label {
|
||||
display: block;
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
|
||||
.robotstxt-2fa-recovery-confirm input {
|
||||
max-width: 200px;
|
||||
}
|
||||
BIN
assets/img/banner-1544x500.png
Normal file
BIN
assets/img/banner-1544x500.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 198 KiB |
BIN
assets/img/banner-772x250.png
Normal file
BIN
assets/img/banner-772x250.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
BIN
assets/img/banner.png
Normal file
BIN
assets/img/banner.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.8 MiB |
BIN
assets/img/icon-128x128.png
Normal file
BIN
assets/img/icon-128x128.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 8 KiB |
BIN
assets/img/icon-256x256.png
Normal file
BIN
assets/img/icon-256x256.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
assets/img/icon.png
Normal file
BIN
assets/img/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.2 MiB |
111
assets/js/recovery-codes.js
Normal file
111
assets/js/recovery-codes.js
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
( function() {
|
||||
'use strict';
|
||||
|
||||
const settings = window.robotstxt2FARecovery || {};
|
||||
|
||||
document.addEventListener( 'DOMContentLoaded', () => {
|
||||
const root = document;
|
||||
|
||||
bindCopyButtons( root );
|
||||
} );
|
||||
|
||||
function bindCopyButtons( scope ) {
|
||||
const buttons = scope.querySelectorAll( '[data-robotstxt-2fa-copy-button]' );
|
||||
|
||||
buttons.forEach( ( button ) => {
|
||||
if ( '1' === button.dataset.robotstxt2FaCopyBound ) {
|
||||
return;
|
||||
}
|
||||
|
||||
button.dataset.robotstxt2FaCopyBound = '1';
|
||||
|
||||
button.addEventListener( 'click', () => {
|
||||
const container = button.closest( '[data-robotstxt-2fa-codes-scope]' );
|
||||
|
||||
if ( ! container ) {
|
||||
return;
|
||||
}
|
||||
|
||||
const codes = Array.from( container.querySelectorAll( '[data-robotstxt-2fa-code]' ) )
|
||||
.map( ( element ) => element.textContent || '' )
|
||||
.filter( ( value ) => value.trim().length > 0 );
|
||||
|
||||
if ( ! codes.length ) {
|
||||
return;
|
||||
}
|
||||
|
||||
copyCodes( codes.join( '\n' ), container );
|
||||
} );
|
||||
} );
|
||||
}
|
||||
|
||||
function copyCodes( text, scope ) {
|
||||
const feedback = scope.querySelector( '[data-robotstxt-2fa-copy-feedback]' );
|
||||
const confirmMessage = getString( 'copyConfirm' );
|
||||
const fallbackMessage = getString( 'copyFallback' );
|
||||
|
||||
const updateFeedback = ( message, isError ) => {
|
||||
if ( ! feedback || ! message ) {
|
||||
return;
|
||||
}
|
||||
|
||||
feedback.hidden = false;
|
||||
feedback.textContent = message;
|
||||
|
||||
if ( isError ) {
|
||||
feedback.classList.add( 'error' );
|
||||
} else {
|
||||
feedback.classList.remove( 'error' );
|
||||
}
|
||||
};
|
||||
|
||||
if ( navigator.clipboard && navigator.clipboard.writeText ) {
|
||||
navigator.clipboard.writeText( text )
|
||||
.then( () => {
|
||||
if ( confirmMessage ) {
|
||||
updateFeedback( confirmMessage, false );
|
||||
}
|
||||
} )
|
||||
.catch( () => {
|
||||
if ( fallbackMessage ) {
|
||||
updateFeedback( fallbackMessage, true );
|
||||
}
|
||||
} );
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
const helper = document.createElement( 'textarea' );
|
||||
helper.value = text;
|
||||
helper.setAttribute( 'readonly', 'readonly' );
|
||||
helper.style.position = 'absolute';
|
||||
helper.style.left = '-9999px';
|
||||
document.body.appendChild( helper );
|
||||
helper.select();
|
||||
|
||||
try {
|
||||
const success = document.execCommand( 'copy' );
|
||||
|
||||
if ( success && confirmMessage ) {
|
||||
updateFeedback( confirmMessage, false );
|
||||
return;
|
||||
}
|
||||
} catch ( error ) {
|
||||
// Continue to fallback message below when execCommand fails.
|
||||
} finally {
|
||||
document.body.removeChild( helper );
|
||||
}
|
||||
|
||||
if ( fallbackMessage ) {
|
||||
updateFeedback( fallbackMessage, true );
|
||||
}
|
||||
}
|
||||
|
||||
function getString( key ) {
|
||||
if ( settings.strings && settings.strings[ key ] ) {
|
||||
return String( settings.strings[ key ] );
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
}() );
|
||||
42
changelog.txt
Normal file
42
changelog.txt
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# Changelog
|
||||
|
||||
## [Unreleased]
|
||||
### Added
|
||||
- Authenticator app support with stored secrets and QR provisioning powered by the optional `bacon/bacon-qr-code` library.
|
||||
- Recovery code confirmation workflow that requires entering one of the freshly generated codes before hiding them.
|
||||
- Single-use recovery codes with profile management, one-time display, and login validation.
|
||||
- Dedicated verification stage token that secures 2FA screens and allows protected email code resends.
|
||||
- Admin settings page with role-based enforcement controls for two-factor authentication.
|
||||
- Uninstall routine that removes stored plugin options.
|
||||
- Network-wide enforcement options for WordPress multisite installations.
|
||||
- Email-based verification codes with throttled delivery and expiry handling.
|
||||
- Configurable verification frequency that remembers trusted devices while allowing administrators to lock the schedule per site.
|
||||
|
||||
### Changed
|
||||
- Profile method toggles now start unchecked and require validating authenticator and recovery codes before activation, with new inline prompts and regenerated secrets when options are disabled.
|
||||
- The profile screen now keeps recovery codes visible in a two-column grid until one is confirmed, shows remaining counts, and automatically refreshes the list when the stored batch is exhausted.
|
||||
- Email verification now displays the destination address alongside the method label.
|
||||
- The login verification screen now hides the username/password fields, exposes a back-to-login link, and supports email code resends from a dedicated query-flagged URL.
|
||||
- The verification stage now enforces authenticator app codes when they are enabled and exposes secure links to switch between OTP, email, and recovery-code challenges without restarting the login.
|
||||
- Promoted the settings interface to a dedicated top-level Two-Factor Authentication menu for easier discovery.
|
||||
- Adjusted the Two-Factor Authentication menu position so it appears within the plugins section of the admin navigation.
|
||||
- User profile settings now persist preferences and automatically enforce role-based 2FA requirements.
|
||||
- The login screen now auto-submits verification forms once the active method reaches its required length (six digits for OTP, seven for email, eight for recovery codes) and removes the Remember Me control during OTP checks.
|
||||
- Recovery code requests now submit through the native profile form, regenerate codes server-side, and remember the section anchor on the redirect so the refreshed screen focuses the two-factor settings.
|
||||
- The refreshed profile screen renders the newly issued ten codes inside a notice, including copy controls and updated status messaging, without relying on JavaScript-driven form submissions.
|
||||
- The generator button now submits the profile form directly, honours core capability checks, and shares nonce validation with the existing profile workflow.
|
||||
|
||||
### Fixed
|
||||
- Prevented a fatal error on the profile screen by exposing the recovery code batch size helper used during rendering.
|
||||
- Corrected the recovery-code confirmation flow so previews persist until acknowledged and the confirmation code is accepted.
|
||||
- Hardened authenticator QR generation by catching library errors and pointing administrators to the required bacon/bacon-qr-code ^3.0 dependency.
|
||||
- Improved recovery-code AJAX error handling so failed requests surface localized messages instead of silently failing.
|
||||
- Forced roles now see two-factor authentication enabled with the default email method selected in their profile, and per-user data is purged during uninstall.
|
||||
- Restored the login verification handlers so the authenticate filter no longer triggers fatal errors and email challenges complete successfully.
|
||||
- Ensured the profile recovery-code generator always reaches `admin-ajax.php`, even when localized data is missing, so the button reliably displays the codes inline.
|
||||
|
||||
## [0.1.0] - 2024-04-08
|
||||
### Added
|
||||
- Initial skeleton for the 2FA (by ROBOTSTXT) plugin.
|
||||
- Initial documentation files (`readme.txt`, `AGENTS.md`, `changelog.txt`).
|
||||
- Placeholder classes for login handling, user profile integration, and admin settings.
|
||||
5
composer.json
Normal file
5
composer.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"require": {
|
||||
"bacon/bacon-qr-code": "^3.0"
|
||||
}
|
||||
}
|
||||
123
composer.lock
generated
Normal file
123
composer.lock
generated
Normal file
|
|
@ -0,0 +1,123 @@
|
|||
{
|
||||
"_readme": [
|
||||
"This file locks the dependencies of your project to a known state",
|
||||
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
|
||||
"This file is @generated automatically"
|
||||
],
|
||||
"content-hash": "9d7cd0dbebfa0273a358b926795e7b8a",
|
||||
"packages": [
|
||||
{
|
||||
"name": "bacon/bacon-qr-code",
|
||||
"version": "v3.0.1",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/Bacon/BaconQrCode.git",
|
||||
"reference": "f9cc1f52b5a463062251d666761178dbdb6b544f"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/Bacon/BaconQrCode/zipball/f9cc1f52b5a463062251d666761178dbdb6b544f",
|
||||
"reference": "f9cc1f52b5a463062251d666761178dbdb6b544f",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"dasprid/enum": "^1.0.3",
|
||||
"ext-iconv": "*",
|
||||
"php": "^8.1"
|
||||
},
|
||||
"require-dev": {
|
||||
"phly/keep-a-changelog": "^2.12",
|
||||
"phpunit/phpunit": "^10.5.11 || 11.0.4",
|
||||
"spatie/phpunit-snapshot-assertions": "^5.1.5",
|
||||
"squizlabs/php_codesniffer": "^3.9"
|
||||
},
|
||||
"suggest": {
|
||||
"ext-imagick": "to generate QR code images"
|
||||
},
|
||||
"type": "library",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"BaconQrCode\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"BSD-2-Clause"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Ben Scholzen 'DASPRiD'",
|
||||
"email": "mail@dasprids.de",
|
||||
"homepage": "https://dasprids.de/",
|
||||
"role": "Developer"
|
||||
}
|
||||
],
|
||||
"description": "BaconQrCode is a QR code generator for PHP.",
|
||||
"homepage": "https://github.com/Bacon/BaconQrCode",
|
||||
"support": {
|
||||
"issues": "https://github.com/Bacon/BaconQrCode/issues",
|
||||
"source": "https://github.com/Bacon/BaconQrCode/tree/v3.0.1"
|
||||
},
|
||||
"time": "2024-10-01T13:55:55+00:00"
|
||||
},
|
||||
{
|
||||
"name": "dasprid/enum",
|
||||
"version": "1.0.7",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/DASPRiD/Enum.git",
|
||||
"reference": "b5874fa9ed0043116c72162ec7f4fb50e02e7cce"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/DASPRiD/Enum/zipball/b5874fa9ed0043116c72162ec7f4fb50e02e7cce",
|
||||
"reference": "b5874fa9ed0043116c72162ec7f4fb50e02e7cce",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=7.1 <9.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^7 || ^8 || ^9 || ^10 || ^11",
|
||||
"squizlabs/php_codesniffer": "*"
|
||||
},
|
||||
"type": "library",
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
"DASPRiD\\Enum\\": "src/"
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"BSD-2-Clause"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Ben Scholzen 'DASPRiD'",
|
||||
"email": "mail@dasprids.de",
|
||||
"homepage": "https://dasprids.de/",
|
||||
"role": "Developer"
|
||||
}
|
||||
],
|
||||
"description": "PHP 7.1 enum implementation",
|
||||
"keywords": [
|
||||
"enum",
|
||||
"map"
|
||||
],
|
||||
"support": {
|
||||
"issues": "https://github.com/DASPRiD/Enum/issues",
|
||||
"source": "https://github.com/DASPRiD/Enum/tree/1.0.7"
|
||||
},
|
||||
"time": "2025-09-16T12:23:56+00:00"
|
||||
}
|
||||
],
|
||||
"packages-dev": [],
|
||||
"aliases": [],
|
||||
"minimum-stability": "stable",
|
||||
"stability-flags": [],
|
||||
"prefer-stable": false,
|
||||
"prefer-lowest": false,
|
||||
"platform": [],
|
||||
"platform-dev": [],
|
||||
"plugin-api-version": "2.6.0"
|
||||
}
|
||||
415
includes/admin/class-settings-page.php
Normal file
415
includes/admin/class-settings-page.php
Normal file
|
|
@ -0,0 +1,415 @@
|
|||
<?php
|
||||
/**
|
||||
* Admin settings management.
|
||||
*
|
||||
* @package Robotstxt_2FA
|
||||
*/
|
||||
|
||||
namespace Robotstxt\TwoFA\Admin;
|
||||
|
||||
use Robotstxt\TwoFA\Frequency_Options;
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles plugin settings page and enforcement logic configuration.
|
||||
*/
|
||||
class Settings_Page {
|
||||
/**
|
||||
* Option group for settings registration.
|
||||
*/
|
||||
private const OPTION_GROUP = 'robotstxt_2fa_settings_group';
|
||||
|
||||
/**
|
||||
* Option name for storing settings.
|
||||
*/
|
||||
public const OPTION_NAME = 'robotstxt_2fa_settings';
|
||||
|
||||
/**
|
||||
* Settings page slug.
|
||||
*/
|
||||
private const PAGE_SLUG = 'robotstxt-2fa-settings';
|
||||
|
||||
/**
|
||||
* Register admin-related hooks.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register_hooks(): void {
|
||||
add_action( 'admin_menu', array( $this, 'register_menu' ) );
|
||||
|
||||
if ( is_multisite() ) {
|
||||
add_action( 'network_admin_menu', array( $this, 'register_network_menu' ) );
|
||||
}
|
||||
|
||||
add_action( 'admin_init', array( $this, 'register_settings' ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Register plugin settings page on single-site dashboards.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register_menu(): void {
|
||||
$this->register_admin_page( false );
|
||||
}
|
||||
|
||||
/**
|
||||
* Register plugin settings page on the network dashboard.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register_network_menu(): void {
|
||||
$this->register_admin_page( true );
|
||||
}
|
||||
|
||||
/**
|
||||
* Render plugin settings page.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function render_page(): void {
|
||||
$capability = $this->get_required_capability();
|
||||
|
||||
if ( ! current_user_can( $capability ) ) {
|
||||
wp_die( esc_html__( 'Sorry, you are not allowed to access this page.', 'robotstxt-2fa' ) );
|
||||
}
|
||||
|
||||
settings_errors( self::OPTION_NAME );
|
||||
?>
|
||||
<div class="wrap">
|
||||
<h1><?php esc_html_e( 'Two-Factor Authentication settings', 'robotstxt-2fa' ); ?></h1>
|
||||
<form action="options.php" method="post">
|
||||
<?php
|
||||
settings_fields( self::OPTION_GROUP );
|
||||
do_settings_sections( self::PAGE_SLUG );
|
||||
submit_button();
|
||||
?>
|
||||
</form>
|
||||
</div>
|
||||
<?php
|
||||
}
|
||||
|
||||
/**
|
||||
* Register settings and sections.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function register_settings(): void {
|
||||
register_setting(
|
||||
self::OPTION_GROUP,
|
||||
self::OPTION_NAME,
|
||||
array(
|
||||
'type' => 'array',
|
||||
'sanitize_callback' => array( $this, 'sanitize_settings' ),
|
||||
'default' => $this->get_default_settings(),
|
||||
)
|
||||
);
|
||||
|
||||
add_settings_section(
|
||||
'robotstxt_2fa_general',
|
||||
__( 'General options', 'robotstxt-2fa' ),
|
||||
array( $this, 'render_general_section' ),
|
||||
self::PAGE_SLUG
|
||||
);
|
||||
|
||||
add_settings_field(
|
||||
'robotstxt_2fa_force_roles',
|
||||
__( 'Forced roles', 'robotstxt-2fa' ),
|
||||
array( $this, 'render_force_roles_field' ),
|
||||
self::PAGE_SLUG,
|
||||
'robotstxt_2fa_general'
|
||||
);
|
||||
|
||||
add_settings_field(
|
||||
'robotstxt_2fa_frequency',
|
||||
__( 'Verification frequency', 'robotstxt-2fa' ),
|
||||
array( $this, 'render_frequency_field' ),
|
||||
self::PAGE_SLUG,
|
||||
'robotstxt_2fa_general'
|
||||
);
|
||||
|
||||
add_settings_field(
|
||||
'robotstxt_2fa_force_frequency',
|
||||
__( 'Enforce frequency', 'robotstxt-2fa' ),
|
||||
array( $this, 'render_force_frequency_field' ),
|
||||
self::PAGE_SLUG,
|
||||
'robotstxt_2fa_general'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render general settings section description.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function render_general_section(): void {
|
||||
echo '<p>' . esc_html__( 'Control how two-factor authentication is enforced for user roles.', 'robotstxt-2fa' ) . '</p>';
|
||||
|
||||
if ( $this->has_network_settings() && ! $this->is_network_context() ) {
|
||||
echo '<p class="description">' . esc_html__( 'These settings are locked by a network administrator. Any changes made here will be ignored.', 'robotstxt-2fa' ) . '</p>';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Render forced roles field.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function render_force_roles_field(): void {
|
||||
$settings = $this->get_settings();
|
||||
$selected_roles = array();
|
||||
$disabled_attr = '';
|
||||
|
||||
if ( isset( $settings['force_roles'] ) && is_array( $settings['force_roles'] ) ) {
|
||||
$selected_roles = $settings['force_roles'];
|
||||
}
|
||||
|
||||
if ( $this->has_network_settings() && ! $this->is_network_context() ) {
|
||||
$disabled_attr = disabled( true, true, false );
|
||||
}
|
||||
|
||||
$roles = get_editable_roles();
|
||||
|
||||
if ( empty( $roles ) ) {
|
||||
echo '<p class="description">' . esc_html__( 'No editable roles were found.', 'robotstxt-2fa' ) . '</p>';
|
||||
return;
|
||||
}
|
||||
|
||||
foreach ( $roles as $role_key => $role_details ) {
|
||||
printf(
|
||||
'<label><input type="checkbox" name="%1$s[force_roles][]" value="%2$s" %3$s %4$s/> %5$s</label><br />',
|
||||
esc_attr( self::OPTION_NAME ),
|
||||
esc_attr( $role_key ),
|
||||
checked( in_array( $role_key, $selected_roles, true ), true, false ),
|
||||
$disabled_attr,
|
||||
esc_html( translate_user_role( $role_details['name'] ) )
|
||||
);
|
||||
}
|
||||
|
||||
echo '<p class="description">' . esc_html__( 'Users assigned to the selected roles must enable two-factor authentication. Leave all roles unchecked to allow each user to decide whether to activate 2FA.', 'robotstxt-2fa' ) . '</p>';
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitize settings before saving them.
|
||||
*
|
||||
* @param mixed $raw_settings Raw settings submitted by the user.
|
||||
*
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
public function sanitize_settings( $raw_settings ): array {
|
||||
$capability = $this->get_required_capability();
|
||||
|
||||
if ( ! current_user_can( $capability ) ) {
|
||||
add_settings_error(
|
||||
self::OPTION_NAME,
|
||||
'robotstxt_2fa_capability',
|
||||
__( 'You are not allowed to update these settings.', 'robotstxt-2fa' )
|
||||
);
|
||||
|
||||
return $this->get_settings();
|
||||
}
|
||||
|
||||
$raw_settings = is_array( $raw_settings ) ? $raw_settings : array();
|
||||
|
||||
$sanitized = $this->get_default_settings();
|
||||
$current_settings = $this->get_settings();
|
||||
|
||||
$sanitized['force_roles'] = array();
|
||||
|
||||
if ( isset( $raw_settings['force_roles'] ) && is_array( $raw_settings['force_roles'] ) ) {
|
||||
$editable_roles = array_keys( get_editable_roles() );
|
||||
|
||||
foreach ( $raw_settings['force_roles'] as $role_key ) {
|
||||
$role_key = sanitize_key( $role_key );
|
||||
|
||||
if ( in_array( $role_key, $editable_roles, true ) ) {
|
||||
$sanitized['force_roles'][] = $role_key;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$sanitized['force_roles'] = array_values( array_unique( $sanitized['force_roles'] ) );
|
||||
|
||||
$frequency_value = $sanitized['frequency'];
|
||||
|
||||
if ( isset( $current_settings['frequency'] ) ) {
|
||||
$frequency_value = (string) $current_settings['frequency'];
|
||||
}
|
||||
|
||||
if ( isset( $raw_settings['frequency'] ) ) {
|
||||
$frequency_value = (string) $raw_settings['frequency'];
|
||||
}
|
||||
|
||||
$sanitized['frequency'] = Frequency_Options::sanitize( $frequency_value );
|
||||
|
||||
if ( $this->has_network_settings() && ! $this->is_network_context() ) {
|
||||
$sanitized['force_frequency'] = ! empty( $current_settings['force_frequency'] ?? false );
|
||||
} elseif ( array_key_exists( 'force_frequency', $raw_settings ) ) {
|
||||
$sanitized['force_frequency'] = '1' === (string) $raw_settings['force_frequency'];
|
||||
}
|
||||
|
||||
return $sanitized;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve plugin settings.
|
||||
*
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
public function get_settings(): array {
|
||||
$options = array();
|
||||
|
||||
if ( is_multisite() ) {
|
||||
/** @var array<string, mixed>|false $network_options */
|
||||
$network_options = get_site_option( self::OPTION_NAME, false );
|
||||
|
||||
if ( false !== $network_options && is_array( $network_options ) ) {
|
||||
$options = $network_options;
|
||||
}
|
||||
}
|
||||
|
||||
if ( empty( $options ) ) {
|
||||
/** @var array<string, mixed> $options */
|
||||
$options = get_option( self::OPTION_NAME, array() );
|
||||
}
|
||||
|
||||
return wp_parse_args( $options, $this->get_default_settings() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve default settings.
|
||||
*
|
||||
* @return array<string, mixed>
|
||||
*/
|
||||
private function get_default_settings(): array {
|
||||
return array(
|
||||
'force_roles' => array(),
|
||||
'default_method' => 'email',
|
||||
'frequency' => Frequency_Options::FREQUENCY_SESSION,
|
||||
'force_frequency' => false,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render verification frequency field.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function render_frequency_field(): void {
|
||||
$settings = $this->get_settings();
|
||||
$selected = Frequency_Options::sanitize( (string) $settings['frequency'] );
|
||||
$disabled_attr = '';
|
||||
|
||||
if ( $this->has_network_settings() && ! $this->is_network_context() ) {
|
||||
$disabled_attr = disabled( true, true, false );
|
||||
}
|
||||
|
||||
$options = Frequency_Options::get_options();
|
||||
|
||||
echo '<select name="' . esc_attr( self::OPTION_NAME ) . '[frequency]" ' . $disabled_attr . '>';
|
||||
|
||||
foreach ( $options as $value => $labels ) {
|
||||
printf(
|
||||
'<option value="%1$s" %2$s>%3$s</option>',
|
||||
esc_attr( $value ),
|
||||
selected( $selected, $value, false ),
|
||||
esc_html( $labels['label'] )
|
||||
);
|
||||
}
|
||||
|
||||
echo '</select>';
|
||||
|
||||
if ( isset( $options[ $selected ]['description'] ) && '' !== $options[ $selected ]['description'] ) {
|
||||
echo '<p class="description">' . esc_html( $options[ $selected ]['description'] ) . '</p>';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Render frequency enforcement checkbox.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function render_force_frequency_field(): void {
|
||||
$settings = $this->get_settings();
|
||||
$is_checked = ! empty( $settings['force_frequency'] );
|
||||
$disabled_attr = '';
|
||||
|
||||
if ( $this->has_network_settings() && ! $this->is_network_context() ) {
|
||||
$disabled_attr = disabled( true, true, false );
|
||||
}
|
||||
|
||||
if ( '' === $disabled_attr ) {
|
||||
printf(
|
||||
'<input type="hidden" name="%1$s[force_frequency]" value="0" />',
|
||||
esc_attr( self::OPTION_NAME )
|
||||
);
|
||||
}
|
||||
|
||||
printf(
|
||||
'<label><input type="checkbox" name="%1$s[force_frequency]" value="1" %2$s %3$s/> %4$s</label>',
|
||||
esc_attr( self::OPTION_NAME ),
|
||||
checked( $is_checked, true, false ),
|
||||
$disabled_attr,
|
||||
esc_html__( 'Prevent users from overriding the global verification frequency.', 'robotstxt-2fa' )
|
||||
);
|
||||
|
||||
echo '<p class="description">' . esc_html__( 'When enabled, users will see the profile frequency control disabled and must follow the global schedule.', 'robotstxt-2fa' ) . '</p>';
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine the capability required to manage settings.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function get_required_capability(): string {
|
||||
return 'manage_options';
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the current request runs in a network admin context.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private function is_network_context(): bool {
|
||||
return is_multisite() && is_network_admin();
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if network-level settings have been stored.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private function has_network_settings(): bool {
|
||||
if ( ! is_multisite() ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return false !== get_site_option( self::OPTION_NAME, false );
|
||||
}
|
||||
|
||||
/**
|
||||
* Register the plugin admin page in the desired context.
|
||||
*
|
||||
* @param bool $network Whether the menu is registered for the network dashboard.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function register_admin_page( bool $network ): void {
|
||||
unset( $network );
|
||||
|
||||
$capability = $this->get_required_capability();
|
||||
|
||||
add_menu_page(
|
||||
__( '2FA (by ROBOTSTXT)', 'robotstxt-2fa' ),
|
||||
__( '2FA', 'robotstxt-2fa' ),
|
||||
$capability,
|
||||
self::PAGE_SLUG,
|
||||
array( $this, 'render_page' ),
|
||||
'dashicons-shield'
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
110
includes/class-frequency-options.php
Normal file
110
includes/class-frequency-options.php
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
<?php
|
||||
/**
|
||||
* Normalize and expose two-factor verification frequency options.
|
||||
*
|
||||
* @package Robotstxt_2FA
|
||||
*/
|
||||
|
||||
namespace Robotstxt\TwoFA;
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Utility helpers for two-factor verification frequency handling.
|
||||
*/
|
||||
class Frequency_Options {
|
||||
/**
|
||||
* Frequency key representing per-session verification.
|
||||
*/
|
||||
public const FREQUENCY_SESSION = 'session';
|
||||
|
||||
/**
|
||||
* Frequency key representing at most one verification per day.
|
||||
*/
|
||||
public const FREQUENCY_DAILY = 'daily';
|
||||
|
||||
/**
|
||||
* Frequency key representing at most one verification per week.
|
||||
*/
|
||||
public const FREQUENCY_WEEKLY = 'weekly';
|
||||
|
||||
/**
|
||||
* Frequency key representing at most one verification per 28 days.
|
||||
*/
|
||||
public const FREQUENCY_MONTHLY = 'monthly';
|
||||
|
||||
/**
|
||||
* Retrieve the available frequency options for display.
|
||||
*
|
||||
* @return array<string, array<string, string>>
|
||||
*/
|
||||
public static function get_options(): array {
|
||||
return array(
|
||||
self::FREQUENCY_SESSION => array(
|
||||
'label' => __( 'Every login', 'robotstxt-2fa' ),
|
||||
'description' => __( 'Always require a new verification code after the password step.', 'robotstxt-2fa' ),
|
||||
),
|
||||
self::FREQUENCY_DAILY => array(
|
||||
'label' => __( 'Daily', 'robotstxt-2fa' ),
|
||||
'description' => __( 'Remember successful verifications for 24 hours per device.', 'robotstxt-2fa' ),
|
||||
),
|
||||
self::FREQUENCY_WEEKLY => array(
|
||||
'label' => __( 'Weekly', 'robotstxt-2fa' ),
|
||||
'description' => __( 'Remember successful verifications for 7 days per device.', 'robotstxt-2fa' ),
|
||||
),
|
||||
self::FREQUENCY_MONTHLY => array(
|
||||
'label' => __( 'Monthly', 'robotstxt-2fa' ),
|
||||
'description' => __( 'Remember successful verifications for 28 days per device.', 'robotstxt-2fa' ),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the allowed option keys.
|
||||
*
|
||||
* @return array<int, string>
|
||||
*/
|
||||
public static function get_allowed_keys(): array {
|
||||
return array_keys( self::get_options() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitize a frequency key against the supported values.
|
||||
*
|
||||
* @param string $frequency Submitted frequency value.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public static function sanitize( string $frequency ): string {
|
||||
$frequency = sanitize_key( $frequency );
|
||||
|
||||
if ( in_array( $frequency, self::get_allowed_keys(), true ) ) {
|
||||
return $frequency;
|
||||
}
|
||||
|
||||
return self::FREQUENCY_SESSION;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve the interval in seconds represented by a frequency.
|
||||
*
|
||||
* @param string $frequency Frequency identifier.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public static function get_interval_seconds( string $frequency ): int {
|
||||
switch ( $frequency ) {
|
||||
case self::FREQUENCY_DAILY:
|
||||
return DAY_IN_SECONDS;
|
||||
case self::FREQUENCY_WEEKLY:
|
||||
return WEEK_IN_SECONDS;
|
||||
case self::FREQUENCY_MONTHLY:
|
||||
return 28 * DAY_IN_SECONDS;
|
||||
case self::FREQUENCY_SESSION:
|
||||
default:
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
120
includes/class-plugin.php
Normal file
120
includes/class-plugin.php
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
<?php
|
||||
/**
|
||||
* Core plugin bootstrap.
|
||||
*
|
||||
* @package Robotstxt_2FA
|
||||
*/
|
||||
|
||||
namespace Robotstxt\TwoFA;
|
||||
|
||||
use Robotstxt\TwoFA\Admin\Settings_Page;
|
||||
use Robotstxt\TwoFA\Login\Login_Form_Manager;
|
||||
use Robotstxt\TwoFA\User\Profile_Settings;
|
||||
use Robotstxt\TwoFA\User\Recovery_Codes;
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Main plugin controller.
|
||||
*/
|
||||
class Plugin {
|
||||
/**
|
||||
* Plugin instance.
|
||||
*
|
||||
* @var Plugin|null
|
||||
*/
|
||||
private static ?Plugin $instance = null;
|
||||
|
||||
/**
|
||||
* Login form manager.
|
||||
*
|
||||
* @var Login_Form_Manager
|
||||
*/
|
||||
private Login_Form_Manager $login_manager;
|
||||
|
||||
/**
|
||||
* Profile settings manager.
|
||||
*
|
||||
* @var Profile_Settings
|
||||
*/
|
||||
private Profile_Settings $profile_settings;
|
||||
|
||||
/**
|
||||
* Recovery codes manager.
|
||||
*
|
||||
* @var Recovery_Codes
|
||||
*/
|
||||
private Recovery_Codes $recovery_codes;
|
||||
|
||||
/**
|
||||
* Settings page handler.
|
||||
*
|
||||
* @var Settings_Page
|
||||
*/
|
||||
private Settings_Page $settings_page;
|
||||
|
||||
/**
|
||||
* Get singleton instance.
|
||||
*
|
||||
* @return Plugin
|
||||
*/
|
||||
public static function get_instance(): Plugin {
|
||||
if ( null === self::$instance ) {
|
||||
self::$instance = new self();
|
||||
}
|
||||
|
||||
return self::$instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public function __construct() {
|
||||
$this->login_manager = new Login_Form_Manager();
|
||||
$this->profile_settings = new Profile_Settings();
|
||||
$this->recovery_codes = new Recovery_Codes();
|
||||
$this->settings_page = new Settings_Page();
|
||||
}
|
||||
|
||||
/**
|
||||
* Plugin initialization.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function init(): void {
|
||||
$this->maybe_load_textdomain();
|
||||
$this->login_manager->register_hooks();
|
||||
$this->profile_settings->register_hooks();
|
||||
$this->recovery_codes->register_hooks();
|
||||
$this->settings_page->register_hooks();
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs on activation.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public static function activate(): void {
|
||||
// Placeholder for activation tasks (option creation, migrations, etc.).
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs on deactivation.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public static function deactivate(): void {
|
||||
// Placeholder for deactivation cleanup logic.
|
||||
}
|
||||
|
||||
/**
|
||||
* Load text domain for translations.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
private function maybe_load_textdomain(): void {
|
||||
load_plugin_textdomain( 'robotstxt-2fa', false, dirname( plugin_basename( ROBOTSTXT_2FA_FILE ) ) . '/languages/' );
|
||||
}
|
||||
}
|
||||
149
includes/login/class-email-code-sender.php
Normal file
149
includes/login/class-email-code-sender.php
Normal file
|
|
@ -0,0 +1,149 @@
|
|||
<?php
|
||||
/**
|
||||
* Email verification code sender.
|
||||
*
|
||||
* @package Robotstxt_2FA
|
||||
*/
|
||||
|
||||
namespace Robotstxt\TwoFA\Login;
|
||||
|
||||
use Robotstxt\TwoFA\User\User_Settings_Repository;
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles generation and delivery of email-based verification codes.
|
||||
*/
|
||||
class Email_Code_Sender {
|
||||
/**
|
||||
* Length of the generated numeric code.
|
||||
*/
|
||||
private const CODE_LENGTH = 7;
|
||||
|
||||
/**
|
||||
* Number of seconds the generated code remains valid.
|
||||
*/
|
||||
private const EXPIRATION_SECONDS = 600;
|
||||
|
||||
/**
|
||||
* Minimum delay between email deliveries in seconds.
|
||||
*/
|
||||
private const RESEND_INTERVAL = 60;
|
||||
|
||||
/**
|
||||
* User settings repository.
|
||||
*
|
||||
* @var User_Settings_Repository
|
||||
*/
|
||||
private User_Settings_Repository $user_settings_repository;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public function __construct() {
|
||||
$this->user_settings_repository = new User_Settings_Repository();
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the expected code length.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function get_code_length(): int {
|
||||
return self::CODE_LENGTH;
|
||||
}
|
||||
|
||||
/**
|
||||
* Send a verification code to the provided user.
|
||||
*
|
||||
* @param \WP_User $user User who is requesting authentication.
|
||||
*
|
||||
* @return bool True when the email was sent or throttled successfully, false on failure.
|
||||
*/
|
||||
public function send_code( \WP_User $user ): bool {
|
||||
if ( empty( $user->user_email ) || ! is_email( $user->user_email ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$challenge = $this->user_settings_repository->get_email_challenge( $user->ID );
|
||||
$current_time = time();
|
||||
|
||||
if ( ! empty( $challenge['hash'] ) && $challenge['expires'] > $current_time && $challenge['sent_at'] >= ( $current_time - self::RESEND_INTERVAL ) ) {
|
||||
return true;
|
||||
}
|
||||
|
||||
$code = $this->generate_code();
|
||||
$expires = $current_time + self::EXPIRATION_SECONDS;
|
||||
|
||||
$blog_name = wp_specialchars_decode( get_option( 'blogname', '' ), ENT_QUOTES );
|
||||
$display_name = wp_strip_all_tags( $user->display_name ?: $user->user_login );
|
||||
$email_subject = sprintf( __( '[%s] Your verification code', 'robotstxt-2fa' ), $blog_name ?: __( 'WordPress', 'robotstxt-2fa' ) );
|
||||
|
||||
$message_lines = array(
|
||||
/* translators: %s: user display name. */
|
||||
sprintf( __( 'Hi %s,', 'robotstxt-2fa' ), $display_name ),
|
||||
'',
|
||||
/* translators: %s: site name. */
|
||||
sprintf( __( 'Use the following verification code to finish signing in to %s:', 'robotstxt-2fa' ), $blog_name ?: __( 'your site', 'robotstxt-2fa' ) ),
|
||||
'',
|
||||
$code,
|
||||
'',
|
||||
__( 'The code expires in 10 minutes.', 'robotstxt-2fa' ),
|
||||
'',
|
||||
__( 'If you did not request this code you can ignore this email.', 'robotstxt-2fa' ),
|
||||
);
|
||||
|
||||
$message = implode( "\n", $message_lines );
|
||||
|
||||
$headers = array( 'Content-Type: text/plain; charset=UTF-8' );
|
||||
|
||||
if ( ! wp_mail( $user->user_email, $email_subject, $message, $headers ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$this->user_settings_repository->store_email_challenge( $user->ID, $code, $expires );
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify a submitted code against the stored challenge.
|
||||
*
|
||||
* @param \WP_User $user User attempting to authenticate.
|
||||
* @param string $code Submitted verification code.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function verify_code( \WP_User $user, string $code ): bool {
|
||||
$challenge = $this->user_settings_repository->get_email_challenge( $user->ID );
|
||||
$code = preg_replace( '/[^0-9]/', '', $code );
|
||||
|
||||
if ( empty( $challenge['hash'] ) ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ( $challenge['expires'] <= time() ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ( '' === $code ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return wp_check_password( $code, $challenge['hash'] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a random numeric verification code.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function generate_code(): string {
|
||||
$max_value = ( 10 ** self::CODE_LENGTH ) - 1;
|
||||
$code = (string) wp_rand( 0, (int) $max_value );
|
||||
|
||||
return str_pad( $code, self::CODE_LENGTH, '0', STR_PAD_LEFT );
|
||||
}
|
||||
}
|
||||
1170
includes/login/class-login-form-manager.php
Normal file
1170
includes/login/class-login-form-manager.php
Normal file
File diff suppressed because it is too large
Load diff
337
includes/user/class-otp-manager.php
Normal file
337
includes/user/class-otp-manager.php
Normal file
|
|
@ -0,0 +1,337 @@
|
|||
<?php
|
||||
/**
|
||||
* Manage authenticator app secrets and QR provisioning.
|
||||
*
|
||||
* @package Robotstxt_2FA
|
||||
*/
|
||||
|
||||
namespace Robotstxt\TwoFA\User;
|
||||
|
||||
use WP_User;
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handles OTP secret storage, verification, and QR generation.
|
||||
*/
|
||||
class OTP_Manager {
|
||||
/**
|
||||
* User meta key that stores the OTP secret.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
private const META_KEY = 'robotstxt_2fa_otp_secret';
|
||||
|
||||
/**
|
||||
* Number of digits generated per OTP code.
|
||||
*/
|
||||
private const CODE_DIGITS = 6;
|
||||
|
||||
/**
|
||||
* Retrieve the number of digits expected for OTP codes.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function get_code_length(): int {
|
||||
return self::CODE_DIGITS;
|
||||
}
|
||||
|
||||
/**
|
||||
* Number of seconds between OTP code changes.
|
||||
*/
|
||||
private const TIME_STEP = 30;
|
||||
|
||||
/**
|
||||
* Default length (in bytes) of generated secrets.
|
||||
*/
|
||||
private const SECRET_LENGTH = 20;
|
||||
|
||||
/**
|
||||
* Retrieve the stored OTP secret for a user.
|
||||
*
|
||||
* @param int $user_id User identifier.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_secret( int $user_id ): string {
|
||||
$secret = get_user_meta( $user_id, self::META_KEY, true );
|
||||
|
||||
if ( ! is_string( $secret ) ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$secret = strtoupper( preg_replace( '/[^A-Z2-7]/', '', $secret ) ?? '' );
|
||||
|
||||
return $secret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensure the user has an OTP secret, generating one if necessary.
|
||||
*
|
||||
* @param WP_User $user User account that needs an OTP secret.
|
||||
*
|
||||
* @return string Generated or existing secret.
|
||||
*/
|
||||
public function ensure_secret( WP_User $user ): string {
|
||||
$secret = $this->get_secret( $user->ID );
|
||||
|
||||
if ( '' !== $secret ) {
|
||||
return $secret;
|
||||
}
|
||||
|
||||
$secret = $this->generate_secret();
|
||||
|
||||
update_user_meta( $user->ID, self::META_KEY, $secret );
|
||||
|
||||
return $secret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the stored OTP secret for a user.
|
||||
*
|
||||
* @param int $user_id User identifier.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function delete_secret( int $user_id ): void {
|
||||
delete_user_meta( $user_id, self::META_KEY );
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify an OTP code against the stored secret.
|
||||
*
|
||||
* @param WP_User $user User attempting to authenticate.
|
||||
* @param string $code Submitted verification code.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function verify_code( WP_User $user, string $code ): bool {
|
||||
$secret = $this->get_secret( $user->ID );
|
||||
|
||||
if ( '' === $secret ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$code = preg_replace( '/[^0-9]/', '', $code );
|
||||
|
||||
if ( null === $code || strlen( $code ) !== self::CODE_DIGITS ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$binary_secret = $this->base32_decode( $secret );
|
||||
|
||||
if ( '' === $binary_secret ) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$current_step = (int) floor( time() / self::TIME_STEP );
|
||||
|
||||
for ( $offset = -1; $offset <= 1; $offset++ ) {
|
||||
$otp = $this->generate_otp_for_counter( $binary_secret, $current_step + $offset );
|
||||
|
||||
if ( hash_equals( $otp, $code ) ) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the provisioning URI used by authenticator apps.
|
||||
*
|
||||
* @param WP_User $user User who owns the OTP secret.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_provisioning_uri( WP_User $user ): string {
|
||||
$secret = $this->get_secret( $user->ID );
|
||||
|
||||
if ( '' === $secret ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$site_name = wp_specialchars_decode( get_option( 'blogname', '' ), ENT_QUOTES );
|
||||
$site_name = '' !== $site_name ? $site_name : __( 'WordPress Site', 'robotstxt-2fa' );
|
||||
$label = '' !== $user->user_email ? $user->user_email : $user->user_login;
|
||||
|
||||
$encoded_label = rawurlencode( sanitize_text_field( $label ) );
|
||||
$encoded_site = rawurlencode( $site_name );
|
||||
$encoded_secret = rawurlencode( $secret );
|
||||
$parameters = array(
|
||||
'issuer' => $encoded_site,
|
||||
'period' => (string) self::TIME_STEP,
|
||||
);
|
||||
|
||||
$query = array();
|
||||
|
||||
foreach ( $parameters as $key => $value ) {
|
||||
$query[] = rawurlencode( $key ) . '=' . $value;
|
||||
}
|
||||
|
||||
return sprintf(
|
||||
'otpauth://totp/%1$s:%2$s?secret=%3$s&%4$s',
|
||||
$encoded_site,
|
||||
$encoded_label,
|
||||
$encoded_secret,
|
||||
implode( '&', $query )
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a QR code and return it as a data URI.
|
||||
*
|
||||
* @param WP_User $user User who owns the OTP secret.
|
||||
*
|
||||
* @return string Data URI containing an SVG image or an empty string when unavailable.
|
||||
*/
|
||||
public function get_qr_code_data_uri( WP_User $user ): string {
|
||||
$uri = $this->get_provisioning_uri( $user );
|
||||
|
||||
if ( '' === $uri ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$svg = $this->render_qr_svg( $uri );
|
||||
|
||||
if ( '' === $svg ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
/*
|
||||
* Encode the SVG payload so it can be embedded safely as a data URI in the admin form.
|
||||
*/
|
||||
return 'data:image/svg+xml;base64,' . base64_encode( $svg ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode -- The QR SVG is encoded to embed it safely as a data URI.
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a new secret encoded in Base32.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function generate_secret(): string {
|
||||
$bytes = random_bytes( self::SECRET_LENGTH );
|
||||
|
||||
return $this->base32_encode( $bytes );
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a QR code in SVG format using an available library.
|
||||
*
|
||||
* @param string $data Data encoded inside the QR code.
|
||||
*
|
||||
* @return string SVG markup or empty string on failure.
|
||||
*/
|
||||
private function render_qr_svg( string $data ): string {
|
||||
if ( ! class_exists( '\BaconQrCode\Writer' ) || ! class_exists( '\BaconQrCode\Renderer\ImageRenderer' ) ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
try {
|
||||
$renderer = new \BaconQrCode\Renderer\ImageRenderer(
|
||||
new \BaconQrCode\Renderer\RendererStyle\RendererStyle( 256 ),
|
||||
new \BaconQrCode\Renderer\Image\SvgImageBackEnd()
|
||||
);
|
||||
$writer = new \BaconQrCode\Writer( $renderer );
|
||||
|
||||
return $writer->writeString( $data );
|
||||
} catch ( \Throwable $exception ) {
|
||||
do_action( 'robotstxt_2fa_qr_generation_failed', $exception, $data );
|
||||
}
|
||||
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Encode binary data using the Base32 alphabet.
|
||||
*
|
||||
* @param string $data Binary string to encode.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function base32_encode( string $data ): string {
|
||||
$alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567';
|
||||
$bits = '';
|
||||
|
||||
for ( $i = 0, $length = strlen( $data ); $i < $length; $i++ ) {
|
||||
$bits .= str_pad( decbin( ord( $data[ $i ] ) ), 8, '0', STR_PAD_LEFT );
|
||||
}
|
||||
|
||||
$chunks = str_split( $bits, 5 );
|
||||
$encoded = '';
|
||||
|
||||
foreach ( $chunks as $chunk ) {
|
||||
if ( strlen( $chunk ) < 5 ) {
|
||||
$chunk = str_pad( $chunk, 5, '0', STR_PAD_RIGHT );
|
||||
}
|
||||
|
||||
$encoded .= $alphabet[ bindec( $chunk ) ];
|
||||
}
|
||||
|
||||
return $encoded;
|
||||
}
|
||||
|
||||
/**
|
||||
* Decode a Base32-encoded string.
|
||||
*
|
||||
* @param string $encoded Encoded secret.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function base32_decode( string $encoded ): string {
|
||||
$alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567';
|
||||
$encoded = strtoupper( $encoded );
|
||||
$encoded = preg_replace( '/[^A-Z2-7]/', '', $encoded );
|
||||
|
||||
if ( null === $encoded || '' === $encoded ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$bits = '';
|
||||
|
||||
for ( $i = 0, $length = strlen( $encoded ); $i < $length; $i++ ) {
|
||||
$position = strpos( $alphabet, $encoded[ $i ] );
|
||||
|
||||
if ( false === $position ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$bits .= str_pad( decbin( $position ), 5, '0', STR_PAD_LEFT );
|
||||
}
|
||||
|
||||
$binary = '';
|
||||
$chunks = str_split( $bits, 8 );
|
||||
|
||||
foreach ( $chunks as $chunk ) {
|
||||
if ( strlen( $chunk ) < 8 ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$binary .= chr( bindec( $chunk ) );
|
||||
}
|
||||
|
||||
return $binary;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate an OTP value for a specific counter.
|
||||
*
|
||||
* @param string $secret Binary secret key.
|
||||
* @param int $counter Time-based counter value.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function generate_otp_for_counter( string $secret, int $counter ): string {
|
||||
$counter = max( 0, $counter );
|
||||
$binary_counter = pack( 'N*', 0 ) . pack( 'N*', $counter );
|
||||
$hash = hash_hmac( 'sha1', $binary_counter, $secret, true );
|
||||
$offset = ord( substr( $hash, -1 ) ) & 0x0F;
|
||||
$segment = substr( $hash, $offset, 4 );
|
||||
$value = unpack( 'N', $segment )[1] & 0x7FFFFFFF;
|
||||
$code = $value % ( 10 ** self::CODE_DIGITS );
|
||||
|
||||
return str_pad( (string) $code, self::CODE_DIGITS, '0', STR_PAD_LEFT );
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue