OpenID Connect login for Funkwhale as a plugin
Turns on django-allauth's generic openid_connect provider, which Funkwhale already ships, and wires it to Funkwhale accounts: actor and libraries on first login, admin by username or group, optional link by e-mail. The front assets add a login button to the web app and proxy /accounts/ to the API. Tested end to end against Funkwhale 2.0.13 and Dex v2.44.0 (tests/compose.yaml). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,4 @@
|
||||
__pycache__/
|
||||
*.egg-info/
|
||||
build/
|
||||
dist/
|
||||
@@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are 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.
|
||||
|
||||
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.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
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 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 work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
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 AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
@@ -0,0 +1,95 @@
|
||||
# funkwhale-oidc
|
||||
|
||||
OpenID Connect login for [Funkwhale](https://funkwhale.audio) 2.x, packaged as a Funkwhale plugin. You don't need to fork Funkwhale or build a custom image. It works with Dex, Keycloak, Authentik, Authelia, or any other OIDC provider that has a discovery document.
|
||||
|
||||
Funkwhale already ships django-allauth. This plugin turns on allauth's generic `openid_connect` provider and connects it to Funkwhale's accounts:
|
||||
|
||||
- **New users** are created on first login, with a username taken from `preferred_username`. They get a federation actor and default libraries, the same as Funkwhale's own sign-up. This works even when the instance's sign-up form is closed, because the provider decides who can get in.
|
||||
- **Admins** can be granted from a list of usernames or from a groups claim.
|
||||
- **Existing local accounts** can optionally be linked by verified e-mail address.
|
||||
- The **web app** gets a "Log in with …" button on every login form. It can also send `/login` straight to the provider; `/login?local=1` still shows the password form.
|
||||
|
||||
Tested with Funkwhale 2.0.13 (django-allauth 65.14.1) and Dex v2.44.0.
|
||||
|
||||
## Install
|
||||
|
||||
The plugin has two parts. The Python package goes on the API side (api, celery worker and celery beat). A small script and stylesheet go on the front side (the nginx image).
|
||||
|
||||
### API
|
||||
|
||||
Install the package and PyJWT into `FUNKWHALE_PLUGINS_PATH` (default `/srv/funkwhale/plugins/`). Funkwhale adds that path to `sys.path`. The Funkwhale image does not include PyJWT, which allauth's OIDC provider needs.
|
||||
|
||||
```sh
|
||||
pip install --target /srv/funkwhale/plugins \
|
||||
https://gitea.eom.dev/DevOps/funkwhale-oidc/archive/v0.1.0.tar.gz
|
||||
```
|
||||
|
||||
In containers, run this as an init step into a shared volume. `tests/compose.yaml` shows how.
|
||||
|
||||
Then set:
|
||||
|
||||
| Variable | Default | |
|
||||
| --- | --- | --- |
|
||||
| `FUNKWHALE_PLUGINS` | | must include `funkwhale_oidc` |
|
||||
| `FUNKWHALE_OIDC_SERVER_URL` | | **required**: issuer URL, e.g. `https://dex.example.com/` |
|
||||
| `FUNKWHALE_OIDC_CLIENT_ID` | | **required** |
|
||||
| `FUNKWHALE_OIDC_CLIENT_SECRET` | | **required** |
|
||||
| `FUNKWHALE_OIDC_PROVIDER_ID` | `oidc` | appears in the callback URL |
|
||||
| `FUNKWHALE_OIDC_NAME` | `Single sign-on` | provider name shown to users |
|
||||
| `FUNKWHALE_OIDC_SCOPES` | `openid,profile,email` | add `groups` for `ADMIN_GROUPS` |
|
||||
| `FUNKWHALE_OIDC_PKCE` | `true` | |
|
||||
| `FUNKWHALE_OIDC_USERNAME_CLAIM` | `preferred_username` | becomes the username and `@user@host` handle, so it must be ASCII |
|
||||
| `FUNKWHALE_OIDC_SIGNUP` | `true` | create accounts for new provider users |
|
||||
| `FUNKWHALE_OIDC_LINK_BY_EMAIL` | `false` | log into an existing local account with the same verified e-mail; only enable this for a provider you trust |
|
||||
| `FUNKWHALE_OIDC_ADMIN_USERS` | | comma-separated usernames made superuser at login |
|
||||
| `FUNKWHALE_OIDC_ADMIN_GROUPS` | | comma-separated groups (from `FUNKWHALE_OIDC_GROUPS_CLAIM`, default `groups`) that grant superuser |
|
||||
|
||||
Admin rights are only ever granted, never revoked; remove them in Funkwhale's admin.
|
||||
|
||||
Register this redirect URI with the provider:
|
||||
|
||||
```
|
||||
https://<funkwhale host>/accounts/oidc/<FUNKWHALE_OIDC_PROVIDER_ID>/login/callback/
|
||||
```
|
||||
|
||||
### Front
|
||||
|
||||
The front image needs three changes:
|
||||
|
||||
The files are in the package under `funkwhale_oidc/front/`, so the same `pip install --target` provides them.
|
||||
|
||||
1. Mount `oidc-login.js` and `oidc-login.css` at `/usr/share/nginx/html/oidc/`.
|
||||
2. Mount `inject.sh` as `/docker-entrypoint.d/98-funkwhale-oidc.sh`. At startup it:
|
||||
- adds the script to `index.html`;
|
||||
- proxies `/accounts/` to the API, which the stock config sends to the web app instead.
|
||||
3. Set these on the front container:
|
||||
- `FUNKWHALE_OIDC_PROVIDER_ID` and `FUNKWHALE_OIDC_NAME`, with the same values as on the API.
|
||||
- `FUNKWHALE_OIDC_AUTO_REDIRECT`: optional, `true` to skip the password form on `/login`.
|
||||
|
||||
If you use your own nginx in front of the API, add this instead:
|
||||
|
||||
```nginx
|
||||
location /accounts/ { include /etc/nginx/funkwhale_proxy.conf; proxy_pass http://funkwhale-api; }
|
||||
```
|
||||
|
||||
Set `FUNKWHALE_SPA_HTML_ROOT` to the front's internal URL (e.g. `http://funkwhale-front/`). The API then serves the same `index.html`, with the script, on the pages it renders itself, such as `/library/albums/1`.
|
||||
|
||||
## Notes
|
||||
|
||||
- **Logging out** of Funkwhale doesn't log you out of the provider. That's why auto-redirect only applies to `/login`, so "log out" doesn't bounce you straight back in.
|
||||
- **Username clashes:** if the claimed username is already taken locally, or isn't valid ASCII, allauth shows its own basic sign-up form so the user can pick another.
|
||||
- **Funkwhale upgrades:** the plugin uses `funkwhale_api.users.models.create_actor` and `create_user_libraries`, and the front script looks for `#username-field`. Run the end-to-end test after upgrading Funkwhale.
|
||||
|
||||
## Test
|
||||
|
||||
```sh
|
||||
docker compose -f tests/compose.yaml up -d
|
||||
# http://funkwhale.localhost/login → "Log in with Dex" → admin@example.com / password
|
||||
docker compose -f tests/compose.yaml down -v
|
||||
```
|
||||
|
||||
This brings up Funkwhale (api, worker, front), PostgreSQL, Redis and a throwaway Dex, with the plugin installed exactly as described above.
|
||||
|
||||
## License
|
||||
|
||||
AGPL-3.0-or-later, the same as Funkwhale, whose code this plugin imports.
|
||||
@@ -0,0 +1,4 @@
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
"""OpenID Connect login for Funkwhale, as a Funkwhale plugin."""
|
||||
|
||||
__version__ = "0.1.0"
|
||||
@@ -0,0 +1,82 @@
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
import logging
|
||||
|
||||
from allauth.socialaccount.adapter import DefaultSocialAccountAdapter
|
||||
from django.conf import settings
|
||||
|
||||
from funkwhale_api.users import models as users_models
|
||||
from funkwhale_api.users.adapters import FunkwhaleAccountAdapter
|
||||
|
||||
from . import conf
|
||||
|
||||
logger = logging.getLogger("funkwhale_oidc")
|
||||
|
||||
|
||||
def _oidc_path():
|
||||
from allauth.socialaccount import app_settings
|
||||
|
||||
return f"/accounts/{app_settings.OPENID_CONNECT_URL_PREFIX or ''}".rstrip("/") + "/"
|
||||
|
||||
|
||||
class AccountAdapter(FunkwhaleAccountAdapter):
|
||||
# Funkwhale answers "noop" so its JSON login API never redirects. After
|
||||
# the provider's callback there is a browser to send home instead.
|
||||
def get_login_redirect_url(self, request):
|
||||
if request.path.startswith(_oidc_path()):
|
||||
return "/"
|
||||
return super().get_login_redirect_url(request)
|
||||
|
||||
def get_signup_redirect_url(self, request):
|
||||
if request.path.startswith(_oidc_path()):
|
||||
return "/"
|
||||
return super().get_signup_redirect_url(request)
|
||||
|
||||
|
||||
def _claims(sociallogin):
|
||||
data = sociallogin.account.extra_data or {}
|
||||
return data.get("userinfo") or data.get("id_token") or data
|
||||
|
||||
|
||||
class SocialAccountAdapter(DefaultSocialAccountAdapter):
|
||||
def is_open_for_signup(self, request, sociallogin):
|
||||
return conf.get()["signup"]
|
||||
|
||||
def populate_user(self, request, sociallogin, data):
|
||||
user = super().populate_user(request, sociallogin, data)
|
||||
claim = conf.get()["username_claim"]
|
||||
username = _claims(sociallogin).get(claim)
|
||||
if username:
|
||||
user.username = username
|
||||
return user
|
||||
|
||||
def save_user(self, request, sociallogin, form=None):
|
||||
user = super().save_user(request, sociallogin, form)
|
||||
# Same steps as Funkwhale's own sign-up (users/serializers.py): a
|
||||
# federation actor and the default libraries.
|
||||
if not user.actor:
|
||||
users_models.create_actor(user)
|
||||
users_models.create_user_libraries(user)
|
||||
logger.info("Created Funkwhale account %s from OIDC", user.username)
|
||||
self._grant_admin(user, sociallogin)
|
||||
return user
|
||||
|
||||
def pre_social_login(self, request, sociallogin):
|
||||
super().pre_social_login(request, sociallogin)
|
||||
if sociallogin.is_existing:
|
||||
self._grant_admin(sociallogin.user, sociallogin)
|
||||
|
||||
def _grant_admin(self, user, sociallogin):
|
||||
c = conf.get()
|
||||
groups = _claims(sociallogin).get(c["groups_claim"]) or []
|
||||
if isinstance(groups, str):
|
||||
groups = [groups]
|
||||
if user.username not in c["admin_users"] and not set(groups) & set(c["admin_groups"]):
|
||||
return
|
||||
fields = {"is_staff": True, "is_superuser": True}
|
||||
fields.update({f"permission_{p}": True for p in users_models.PERMISSIONS})
|
||||
changed = [k for k, v in fields.items() if getattr(user, k) != v]
|
||||
if changed:
|
||||
for k in changed:
|
||||
setattr(user, k, fields[k])
|
||||
user.save(update_fields=changed)
|
||||
logger.info("Granted admin to %s from OIDC", user.username)
|
||||
@@ -0,0 +1,54 @@
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
from django.apps import AppConfig
|
||||
from django.conf import settings
|
||||
from django.core.exceptions import ImproperlyConfigured
|
||||
|
||||
from . import conf
|
||||
|
||||
|
||||
class FunkwhaleOIDCConfig(AppConfig):
|
||||
name = "funkwhale_oidc"
|
||||
label = "funkwhale_oidc"
|
||||
verbose_name = "OpenID Connect login"
|
||||
|
||||
def ready(self):
|
||||
c = conf.get()
|
||||
missing = [k for k in ("server_url", "client_id", "client_secret") if not c[k]]
|
||||
if missing:
|
||||
raise ImproperlyConfigured(
|
||||
"funkwhale_oidc: set "
|
||||
+ ", ".join(f"FUNKWHALE_OIDC_{k.upper()}" for k in missing)
|
||||
)
|
||||
|
||||
# django-allauth reads its settings on every access, so setting them
|
||||
# here (after Funkwhale's settings module ran) is enough.
|
||||
settings.SOCIALACCOUNT_PROVIDERS = {
|
||||
**getattr(settings, "SOCIALACCOUNT_PROVIDERS", {}),
|
||||
"openid_connect": {
|
||||
"OAUTH_PKCE_ENABLED": c["pkce"],
|
||||
"APPS": [
|
||||
{
|
||||
"provider_id": c["provider_id"],
|
||||
"name": c["name"],
|
||||
"client_id": c["client_id"],
|
||||
"secret": c["client_secret"],
|
||||
"settings": {
|
||||
"server_url": c["server_url"],
|
||||
"scope": c["scopes"],
|
||||
},
|
||||
}
|
||||
],
|
||||
},
|
||||
}
|
||||
settings.SOCIALACCOUNT_ADAPTER = "funkwhale_oidc.adapters.SocialAccountAdapter"
|
||||
settings.ACCOUNT_ADAPTER = "funkwhale_oidc.adapters.AccountAdapter"
|
||||
# The SPA links straight to the provider; there is no allauth HTML
|
||||
# page in Funkwhale to confirm a POST on.
|
||||
# Callback URLs are built from the request; behind a TLS-terminating
|
||||
# proxy that may look like plain http.
|
||||
settings.ACCOUNT_DEFAULT_HTTP_PROTOCOL = getattr(settings, "FUNKWHALE_PROTOCOL", "https")
|
||||
settings.SOCIALACCOUNT_LOGIN_ON_GET = True
|
||||
settings.SOCIALACCOUNT_AUTO_SIGNUP = True
|
||||
settings.SOCIALACCOUNT_STORE_TOKENS = False
|
||||
settings.SOCIALACCOUNT_EMAIL_AUTHENTICATION = c["link_by_email"]
|
||||
settings.SOCIALACCOUNT_EMAIL_AUTHENTICATION_AUTO_CONNECT = c["link_by_email"]
|
||||
@@ -0,0 +1,43 @@
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
"""Configuration, read from FUNKWHALE_OIDC_* environment variables."""
|
||||
|
||||
import functools
|
||||
|
||||
import environ
|
||||
|
||||
PREFIX = "FUNKWHALE_OIDC_"
|
||||
|
||||
|
||||
@functools.cache
|
||||
def get():
|
||||
env = environ.Env()
|
||||
|
||||
def e(name, default=None, cast=env.str):
|
||||
return cast(PREFIX + name, default=default)
|
||||
|
||||
return {
|
||||
# Issuer URL; /.well-known/openid-configuration is appended.
|
||||
"server_url": e("SERVER_URL", ""),
|
||||
"client_id": e("CLIENT_ID", ""),
|
||||
"client_secret": e("CLIENT_SECRET", ""),
|
||||
# Part of the callback URL: /accounts/oidc/<provider_id>/login/callback/
|
||||
"provider_id": e("PROVIDER_ID", "oidc"),
|
||||
# Shown on the login button.
|
||||
"name": e("NAME", "Single sign-on"),
|
||||
"scopes": e("SCOPES", ["openid", "profile", "email"], env.list),
|
||||
"pkce": e("PKCE", True, env.bool),
|
||||
# Claim used as the Funkwhale username (and federation handle).
|
||||
"username_claim": e("USERNAME_CLAIM", "preferred_username"),
|
||||
# Create accounts for new provider users even when the instance's
|
||||
# own sign-up form is closed. The provider decides who gets in.
|
||||
"signup": e("SIGNUP", True, env.bool),
|
||||
# Log a provider user into the existing local account with the same
|
||||
# (provider-verified) e-mail. Only enable for a provider you trust
|
||||
# to verify e-mail addresses.
|
||||
"link_by_email": e("LINK_BY_EMAIL", False, env.bool),
|
||||
# Superuser on every login if the username is listed, or if the
|
||||
# groups claim contains one of the groups. Never revoked here.
|
||||
"admin_users": e("ADMIN_USERS", [], env.list),
|
||||
"admin_groups": e("ADMIN_GROUPS", [], env.list),
|
||||
"groups_claim": e("GROUPS_CLAIM", "groups"),
|
||||
}
|
||||
Executable
+24
@@ -0,0 +1,24 @@
|
||||
#!/bin/sh
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
# Funkwhale front image hook: copy into /docker-entrypoint.d/ (e.g. as
|
||||
# 98-funkwhale-oidc.sh). Adds oidc-login.{js,css} to index.html once.
|
||||
# Expects the two files under /usr/share/nginx/html/oidc/ and reads
|
||||
# FUNKWHALE_OIDC_PROVIDER_ID, FUNKWHALE_OIDC_NAME, FUNKWHALE_OIDC_AUTO_REDIRECT.
|
||||
set -eu
|
||||
index=/usr/share/nginx/html/index.html
|
||||
grep -q 'oidc-login.js' "$index" && exit 0
|
||||
esc() { printf '%s' "$1" | sed -e 's/&/\&/g' -e 's/"/\"/g' -e 's/</\</g' -e 's/[|\\]/\\&/g'; }
|
||||
url="/accounts/oidc/$(esc "${FUNKWHALE_OIDC_PROVIDER_ID:-oidc}")/login/"
|
||||
tag="<link rel=\"stylesheet\" href=\"/oidc/oidc-login.css\"><script src=\"/oidc/oidc-login.js\" defer data-login-url=\"$url\" data-name=\"$(esc "${FUNKWHALE_OIDC_NAME:-Single sign-on}")\" data-auto-redirect=\"$(esc "${FUNKWHALE_OIDC_AUTO_REDIRECT:-false}")\"></script>"
|
||||
sed -i "s|</head>|$tag</head>|" "$index"
|
||||
echo "funkwhale-oidc: login button added to $index"
|
||||
|
||||
# The stock front config sends /accounts/ to the SPA; the OIDC login and
|
||||
# callback views live in the API. 20-envsubst-on-templates has already
|
||||
# rendered the config by the time this hook runs.
|
||||
conf=/etc/nginx/conf.d/default.conf
|
||||
if ! grep -q 'location /accounts/' "$conf"; then
|
||||
sed -i 's|^\(\s*\)location /federation/ {|\1location /accounts/ {\n\1 include /etc/nginx/funkwhale_proxy.conf;\n\1 proxy_pass http://funkwhale-api;\n\1}\n\1location /federation/ {|' "$conf"
|
||||
grep -q 'location /accounts/' "$conf" || { echo "funkwhale-oidc: could not add /accounts/ to $conf" >&2; exit 1; }
|
||||
echo "funkwhale-oidc: /accounts/ proxied to the API"
|
||||
fi
|
||||
@@ -0,0 +1,10 @@
|
||||
/* SPDX-License-Identifier: AGPL-3.0-or-later */
|
||||
.funkwhale-oidc { display: flex; flex-direction: column; gap: 12px; }
|
||||
.funkwhale-oidc-login { width: 100%; }
|
||||
.funkwhale-oidc-divider {
|
||||
display: flex; align-items: center; gap: 12px; margin: 0;
|
||||
font-size: 0.875em; opacity: 0.75;
|
||||
}
|
||||
.funkwhale-oidc-divider::before, .funkwhale-oidc-divider::after {
|
||||
content: ""; flex: 1; border-top: 1px solid currentColor; opacity: 0.4;
|
||||
}
|
||||
@@ -0,0 +1,82 @@
|
||||
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
// Adds a "Log in with <provider>" button to every Funkwhale login form.
|
||||
// Load it from index.html (see README):
|
||||
// <script src="/oidc/oidc-login.js" defer
|
||||
// data-login-url="/accounts/oidc/oidc/login/" data-name="Single sign-on"
|
||||
// data-auto-redirect="false"></script>
|
||||
// With data-auto-redirect="true", /login goes straight to the provider;
|
||||
// /login?local=1 still shows the password form.
|
||||
(() => {
|
||||
const script = document.currentScript
|
||||
const cfg = {
|
||||
loginUrl: script?.dataset.loginUrl || '/accounts/oidc/oidc/login/',
|
||||
name: script?.dataset.name || 'Single sign-on',
|
||||
autoRedirect: script?.dataset.autoRedirect === 'true'
|
||||
}
|
||||
|
||||
const nextPath = () => {
|
||||
const params = new URLSearchParams(location.search)
|
||||
const next = params.get('next') || (location.pathname === '/login' ? '/library' : location.pathname + location.search)
|
||||
// Only same-site paths; allauth checks this again server-side.
|
||||
return next.startsWith('/') && !next.startsWith('//') ? next : '/library'
|
||||
}
|
||||
|
||||
const go = () => {
|
||||
location.assign(`${cfg.loginUrl}?${new URLSearchParams({ process: 'login', next: nextPath() })}`)
|
||||
}
|
||||
|
||||
const maybeRedirect = () => {
|
||||
if (!cfg.autoRedirect || location.pathname !== '/login') return false
|
||||
if (new URLSearchParams(location.search).has('local')) return false
|
||||
go()
|
||||
return true
|
||||
}
|
||||
|
||||
const decorate = (form) => {
|
||||
form.dataset.oidc = 'done'
|
||||
const submit = form.querySelector('button[type="submit"]')
|
||||
const button = submit ? submit.cloneNode(false) : document.createElement('button')
|
||||
button.type = 'button'
|
||||
button.removeAttribute('aria-disabled')
|
||||
button.classList.add('funkwhale-oidc-login')
|
||||
for (const c of [...button.classList]) {
|
||||
if (c.startsWith('color-')) button.classList.remove(c)
|
||||
}
|
||||
button.classList.add('color-primary-solid')
|
||||
button.textContent = `Log in with ${cfg.name}`
|
||||
button.addEventListener('click', go)
|
||||
|
||||
const divider = document.createElement('p')
|
||||
divider.className = 'funkwhale-oidc-divider'
|
||||
divider.textContent = 'or use a local account'
|
||||
|
||||
const wrap = document.createElement('div')
|
||||
wrap.className = 'funkwhale-oidc'
|
||||
wrap.append(button, divider)
|
||||
form.prepend(wrap)
|
||||
}
|
||||
|
||||
const scan = () => {
|
||||
for (const field of document.querySelectorAll('#username-field')) {
|
||||
const form = field.closest('form')
|
||||
if (form && !form.dataset.oidc) decorate(form)
|
||||
}
|
||||
}
|
||||
|
||||
// The SPA changes routes with history.pushState; watch both the DOM
|
||||
// (forms appear after render) and navigation (auto-redirect on /login).
|
||||
const onRoute = () => { if (!maybeRedirect()) scan() }
|
||||
for (const fn of ['pushState', 'replaceState']) {
|
||||
const orig = history[fn]
|
||||
history[fn] = function (...args) {
|
||||
const r = orig.apply(this, args)
|
||||
queueMicrotask(onRoute)
|
||||
return r
|
||||
}
|
||||
}
|
||||
addEventListener('popstate', onRoute)
|
||||
if (!maybeRedirect()) {
|
||||
new MutationObserver(scan).observe(document.documentElement, { childList: true, subtree: true })
|
||||
scan()
|
||||
}
|
||||
})()
|
||||
@@ -0,0 +1,4 @@
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
"""Imported by Funkwhale once apps are ready. The work happens in apps.py."""
|
||||
|
||||
from .funkwhale_startup import PLUGIN # noqa: F401
|
||||
@@ -0,0 +1,24 @@
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
"""Imported by Funkwhale while it loads its settings (FUNKWHALE_PLUGINS)."""
|
||||
|
||||
from config import plugins
|
||||
|
||||
from . import __version__
|
||||
|
||||
PLUGIN = plugins.get_plugin_config(
|
||||
name="funkwhale_oidc",
|
||||
label="OpenID Connect login",
|
||||
description="Log in with an external OpenID Connect provider such as Dex or Keycloak.",
|
||||
homepage="https://gitea.eom.dev/DevOps/funkwhale-oidc",
|
||||
version=__version__,
|
||||
)
|
||||
|
||||
|
||||
@plugins.register_filter(plugins.PLUGINS_APPS, PLUGIN)
|
||||
def add_apps(apps, **kwargs):
|
||||
# allauth and allauth.socialaccount are already installed by Funkwhale;
|
||||
# only the generic OIDC provider and this app (for its ready()) are missing.
|
||||
return apps + [
|
||||
"allauth.socialaccount.providers.openid_connect",
|
||||
"funkwhale_oidc.apps.FunkwhaleOIDCConfig",
|
||||
]
|
||||
@@ -0,0 +1,26 @@
|
||||
[build-system]
|
||||
requires = ["setuptools>=69"]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "funkwhale-oidc"
|
||||
dynamic = ["version"]
|
||||
description = "OpenID Connect login for Funkwhale (Dex, Keycloak, Authentik, ...)"
|
||||
readme = "README.md"
|
||||
license = "AGPL-3.0-or-later"
|
||||
requires-python = ">=3.11"
|
||||
# Funkwhale itself (django-allauth, django-environ) is provided by the
|
||||
# Funkwhale image; only allauth's OIDC extra is missing from it.
|
||||
dependencies = ["PyJWT>=2.8,<3"]
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://gitea.eom.dev/DevOps/funkwhale-oidc"
|
||||
|
||||
[tool.setuptools]
|
||||
packages = ["funkwhale_oidc"]
|
||||
|
||||
[tool.setuptools.package-data]
|
||||
funkwhale_oidc = ["front/*"]
|
||||
|
||||
[tool.setuptools.dynamic]
|
||||
version = {attr = "funkwhale_oidc.__version__"}
|
||||
@@ -0,0 +1,94 @@
|
||||
# End-to-end test: Funkwhale 2.0.13 + this plugin + a throwaway Dex.
|
||||
# docker compose -f tests/compose.yaml up -d
|
||||
# open http://funkwhale.localhost/login (admin@example.com / password)
|
||||
# docker compose -f tests/compose.yaml down -v
|
||||
name: funkwhale-oidc-test
|
||||
x-api: &api
|
||||
image: docker.io/funkwhale/api:${FUNKWHALE_VERSION:-2.0.13}
|
||||
depends_on:
|
||||
postgres: {condition: service_started}
|
||||
redis: {condition: service_started}
|
||||
plugins: {condition: service_completed_successfully}
|
||||
extra_hosts: ["dex.localhost:host-gateway"]
|
||||
volumes:
|
||||
- plugins:/srv/funkwhale/plugins:ro
|
||||
- media:/srv/funkwhale/data/media
|
||||
- static:/srv/funkwhale/data/static
|
||||
environment: &env
|
||||
FUNKWHALE_HOSTNAME: funkwhale.localhost
|
||||
FUNKWHALE_PROTOCOL: http
|
||||
FUNKWHALE_API_PORT: "5000"
|
||||
FUNKWHALE_SPA_HTML_ROOT: http://front/
|
||||
DJANGO_SECRET_KEY: test-only-secret-key-test-only-secret-key
|
||||
DATABASE_URL: postgresql://funkwhale:funkwhale@postgres:5432/funkwhale
|
||||
CACHE_URL: redis://redis:6379/0
|
||||
MEDIA_ROOT: /srv/funkwhale/data/media
|
||||
STATIC_ROOT: /srv/funkwhale/data/static
|
||||
MUSIC_DIRECTORY_PATH: /music
|
||||
FUNKWHALE_PLUGINS: funkwhale_oidc
|
||||
FUNKWHALE_OIDC_SERVER_URL: http://dex.localhost:5556/dex
|
||||
FUNKWHALE_OIDC_CLIENT_ID: funkwhale
|
||||
FUNKWHALE_OIDC_CLIENT_SECRET: test-secret
|
||||
FUNKWHALE_OIDC_PROVIDER_ID: dex
|
||||
FUNKWHALE_OIDC_NAME: Dex
|
||||
FUNKWHALE_OIDC_ADMIN_USERS: alice
|
||||
FUNKWHALE_OIDC_LINK_BY_EMAIL: "true"
|
||||
services:
|
||||
postgres:
|
||||
image: postgres:17.11-alpine
|
||||
environment: {POSTGRES_USER: funkwhale, POSTGRES_PASSWORD: funkwhale, POSTGRES_DB: funkwhale}
|
||||
redis:
|
||||
image: redis:7-alpine
|
||||
dex:
|
||||
image: ghcr.io/dexidp/dex:v2.44.0
|
||||
command: [dex, serve, /etc/dex/config.yaml]
|
||||
ports: ["5556:5556"]
|
||||
volumes: ["./dex.yaml:/etc/dex/config.yaml:ro"]
|
||||
# Same as the Kubernetes init container: pip-install the plugin and
|
||||
# PyJWT into FUNKWHALE_PLUGINS_PATH, which Funkwhale puts on sys.path.
|
||||
plugins:
|
||||
image: docker.io/funkwhale/api:${FUNKWHALE_VERSION:-2.0.13}
|
||||
entrypoint: [sh, -c]
|
||||
command: ["cp -r /src /tmp/src && pip install --no-cache-dir --no-compile --upgrade --target /plugins /tmp/src"]
|
||||
volumes: ["..:/src:ro", "plugins:/plugins"]
|
||||
restart: "no"
|
||||
migrate:
|
||||
<<: *api
|
||||
command: sh -c "funkwhale-manage migrate && funkwhale-manage collectstatic --noinput"
|
||||
restart: "no"
|
||||
api:
|
||||
<<: *api
|
||||
command: gunicorn
|
||||
depends_on:
|
||||
migrate: {condition: service_completed_successfully}
|
||||
celeryworker:
|
||||
<<: *api
|
||||
command: celery --app=funkwhale_api.taskapp worker --loglevel=INFO --concurrency=1
|
||||
environment: {<<: *env, C_FORCE_ROOT: "true"}
|
||||
depends_on:
|
||||
migrate: {condition: service_completed_successfully}
|
||||
front:
|
||||
image: docker.io/funkwhale/front:${FUNKWHALE_VERSION:-2.0.13}
|
||||
depends_on: [api]
|
||||
ports: ["80:80"]
|
||||
environment:
|
||||
FUNKWHALE_API_HOST: api
|
||||
FUNKWHALE_API_PORT: "5000"
|
||||
FUNKWHALE_HOSTNAME: funkwhale.localhost
|
||||
FUNKWHALE_PROTOCOL: http
|
||||
NGINX_MAX_BODY_SIZE: 100M
|
||||
MEDIA_ROOT: /srv/funkwhale/data/media
|
||||
MUSIC_DIRECTORY_PATH: /music
|
||||
FUNKWHALE_OIDC_PROVIDER_ID: dex
|
||||
FUNKWHALE_OIDC_NAME: Dex
|
||||
FUNKWHALE_OIDC_AUTO_REDIRECT: "false"
|
||||
volumes:
|
||||
- ../funkwhale_oidc/front/inject.sh:/docker-entrypoint.d/98-funkwhale-oidc.sh:ro
|
||||
- ../funkwhale_oidc/front/oidc-login.js:/usr/share/nginx/html/oidc/oidc-login.js:ro
|
||||
- ../funkwhale_oidc/front/oidc-login.css:/usr/share/nginx/html/oidc/oidc-login.css:ro
|
||||
- media:/srv/funkwhale/data/media:ro
|
||||
- static:/usr/share/nginx/html/staticfiles:ro
|
||||
volumes:
|
||||
plugins:
|
||||
media:
|
||||
static:
|
||||
@@ -0,0 +1,19 @@
|
||||
# Throwaway Dex for tests/compose.yaml. Log in as admin@example.com / password.
|
||||
issuer: http://dex.localhost:5556/dex
|
||||
storage:
|
||||
type: memory
|
||||
web:
|
||||
http: 0.0.0.0:5556
|
||||
enablePasswordDB: true
|
||||
staticPasswords:
|
||||
- email: admin@example.com
|
||||
# bcrypt("password")
|
||||
hash: "$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W"
|
||||
username: alice
|
||||
userID: 08a8684b-db88-4b73-90a9-3cd1661f5466
|
||||
staticClients:
|
||||
- id: funkwhale
|
||||
name: Funkwhale
|
||||
secret: test-secret
|
||||
redirectURIs:
|
||||
- http://funkwhale.localhost/accounts/oidc/dex/login/callback/
|
||||
Reference in New Issue
Block a user