Compare commits
No commits in common. "master" and "feat_admin_cli_invite_user" have entirely different histories.
master
...
feat_admin
63 changed files with 182 additions and 1615 deletions
|
|
@ -1,7 +0,0 @@
|
||||||
target
|
|
||||||
.env
|
|
||||||
tmp
|
|
||||||
Dockerfile
|
|
||||||
.dockerignore
|
|
||||||
justfile
|
|
||||||
config.toml
|
|
||||||
1
.env
1
.env
|
|
@ -0,0 +1 @@
|
||||||
|
APP_JWT_SECRET=bc1996ea-5464-424a-9a38-5604f2bc865a
|
||||||
BIN
.swp
BIN
.swp
Binary file not shown.
58
Cargo.lock
generated
58
Cargo.lock
generated
|
|
@ -349,12 +349,6 @@ dependencies = [
|
||||||
"windows-targets 0.52.6",
|
"windows-targets 0.52.6",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "base64"
|
|
||||||
version = "0.13.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "9e1b586273c5702936fe7b7d6896644d8be71e6314cfe09d3167c95f712589e8"
|
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "base64"
|
name = "base64"
|
||||||
version = "0.21.7"
|
version = "0.21.7"
|
||||||
|
|
@ -885,12 +879,6 @@ version = "0.4.3"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70"
|
checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70"
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "hex-literal"
|
|
||||||
version = "0.4.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "6fe2267d4ed49bc07b63801559be28c718ea06c4738b7a03c94df7386d2cde46"
|
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "hkdf"
|
name = "hkdf"
|
||||||
version = "0.12.4"
|
version = "0.12.4"
|
||||||
|
|
@ -972,13 +960,11 @@ dependencies = [
|
||||||
"chrono",
|
"chrono",
|
||||||
"env_logger",
|
"env_logger",
|
||||||
"fully_pub",
|
"fully_pub",
|
||||||
"jsonwebkey-convert-repaired",
|
|
||||||
"jsonwebtoken",
|
"jsonwebtoken",
|
||||||
"kernel",
|
"kernel",
|
||||||
"log",
|
"log",
|
||||||
"minijinja",
|
"minijinja",
|
||||||
"minijinja-embed",
|
"minijinja-embed",
|
||||||
"pem 3.0.4",
|
|
||||||
"serde",
|
"serde",
|
||||||
"serde_json",
|
"serde_json",
|
||||||
"serde_urlencoded",
|
"serde_urlencoded",
|
||||||
|
|
@ -1246,21 +1232,6 @@ dependencies = [
|
||||||
"wasm-bindgen",
|
"wasm-bindgen",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "jsonwebkey-convert-repaired"
|
|
||||||
version = "0.3.1"
|
|
||||||
source = "git+https://forge.lefuturiste.fr/rust-libs/jsonwebkey-rs-repaired.git?branch=master#0182bf0b83ebaf0a8c64c103422363f00a4fff7f"
|
|
||||||
dependencies = [
|
|
||||||
"base64 0.13.1",
|
|
||||||
"lazy_static",
|
|
||||||
"num-bigint",
|
|
||||||
"pem 0.8.3",
|
|
||||||
"serde",
|
|
||||||
"serde_json",
|
|
||||||
"simple_asn1 0.5.4",
|
|
||||||
"thiserror 1.0.69",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "jsonwebtoken"
|
name = "jsonwebtoken"
|
||||||
version = "9.3.0"
|
version = "9.3.0"
|
||||||
|
|
@ -1269,11 +1240,11 @@ checksum = "b9ae10193d25051e74945f1ea2d0b42e03cc3b890f7e4cc5faa44997d808193f"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"base64 0.21.7",
|
"base64 0.21.7",
|
||||||
"js-sys",
|
"js-sys",
|
||||||
"pem 3.0.4",
|
"pem",
|
||||||
"ring",
|
"ring",
|
||||||
"serde",
|
"serde",
|
||||||
"serde_json",
|
"serde_json",
|
||||||
"simple_asn1 0.6.2",
|
"simple_asn1",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
@ -1285,11 +1256,9 @@ dependencies = [
|
||||||
"dotenvy",
|
"dotenvy",
|
||||||
"env_logger",
|
"env_logger",
|
||||||
"fully_pub",
|
"fully_pub",
|
||||||
"hex-literal",
|
|
||||||
"log",
|
"log",
|
||||||
"serde",
|
"serde",
|
||||||
"serde_json",
|
"serde_json",
|
||||||
"sha2",
|
|
||||||
"sqlx",
|
"sqlx",
|
||||||
"strum",
|
"strum",
|
||||||
"strum_macros",
|
"strum_macros",
|
||||||
|
|
@ -1584,17 +1553,6 @@ version = "1.0.15"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "57c0d7b74b563b49d38dae00a0c37d4d6de9b432382b2892f0574ddcae73fd0a"
|
checksum = "57c0d7b74b563b49d38dae00a0c37d4d6de9b432382b2892f0574ddcae73fd0a"
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "pem"
|
|
||||||
version = "0.8.3"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "fd56cbd21fea48d0c440b41cd69c589faacade08c992d9a54e471b79d0fd13eb"
|
|
||||||
dependencies = [
|
|
||||||
"base64 0.13.1",
|
|
||||||
"once_cell",
|
|
||||||
"regex",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "pem"
|
name = "pem"
|
||||||
version = "3.0.4"
|
version = "3.0.4"
|
||||||
|
|
@ -1955,18 +1913,6 @@ dependencies = [
|
||||||
"rand_core",
|
"rand_core",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "simple_asn1"
|
|
||||||
version = "0.5.4"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "8eb4ea60fb301dc81dfc113df680571045d375ab7345d171c5dc7d7e13107a80"
|
|
||||||
dependencies = [
|
|
||||||
"chrono",
|
|
||||||
"num-bigint",
|
|
||||||
"num-traits",
|
|
||||||
"thiserror 1.0.69",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "simple_asn1"
|
name = "simple_asn1"
|
||||||
version = "0.6.2"
|
version = "0.6.2"
|
||||||
|
|
|
||||||
12
Cargo.toml
12
Cargo.toml
|
|
@ -1,11 +1,9 @@
|
||||||
# cargo-features = ["codegen-backend"]
|
cargo-features = ["codegen-backend"]
|
||||||
|
|
||||||
# [profile.dev]
|
[profile.dev]
|
||||||
# codegen-backend = "cranelift"
|
codegen-backend = "cranelift"
|
||||||
# # END OF
|
|
||||||
|
|
||||||
[workspace]
|
[workspace]
|
||||||
resolver = "2"
|
|
||||||
members = [
|
members = [
|
||||||
"lib/kernel",
|
"lib/kernel",
|
||||||
"lib/utils",
|
"lib/utils",
|
||||||
|
|
@ -23,14 +21,12 @@ strum_macros = "0.26"
|
||||||
uuid = { version = "1.8", features = ["serde", "v4"] }
|
uuid = { version = "1.8", features = ["serde", "v4"] }
|
||||||
dotenvy = "0.15.7"
|
dotenvy = "0.15.7"
|
||||||
url = "2.5.3"
|
url = "2.5.3"
|
||||||
sha2 = "0.10"
|
|
||||||
hex-literal = "0.4"
|
|
||||||
|
|
||||||
# CLI
|
# CLI
|
||||||
argh = "0.1"
|
argh = "0.1"
|
||||||
|
|
||||||
# Async
|
# Async
|
||||||
tokio = { version = "1.40.0", features = ["rt-multi-thread", "macros"] }
|
tokio = { version = "1.40.0", features = ["rt-multi-thread"] }
|
||||||
|
|
||||||
# Logging
|
# Logging
|
||||||
log = "0.4"
|
log = "0.4"
|
||||||
|
|
|
||||||
37
Dockerfile
37
Dockerfile
|
|
@ -1,37 +0,0 @@
|
||||||
FROM rust:1.83-alpine3.20 AS builder
|
|
||||||
|
|
||||||
WORKDIR /usr/src/minauthator
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
RUN apk add musl-dev
|
|
||||||
|
|
||||||
RUN cargo install --bin minauthator-admin --locked --path lib/admin_cli
|
|
||||||
RUN cargo install --bin minauthator-server --locked --path lib/http_server
|
|
||||||
|
|
||||||
FROM alpine:3.20 AS base
|
|
||||||
|
|
||||||
RUN apk add sqlite
|
|
||||||
COPY --from=builder /usr/local/cargo/bin/minauthator-server /usr/local/bin/minauthator-server
|
|
||||||
COPY --from=builder /usr/local/cargo/bin/minauthator-admin /usr/local/bin/minauthator-admin
|
|
||||||
RUN mkdir -p \
|
|
||||||
/usr/local/src/minauthator/migrations \
|
|
||||||
/usr/local/lib/minauthator/assets \
|
|
||||||
/var/lib/minauthator \
|
|
||||||
/etc/minauthator
|
|
||||||
COPY --from=builder /usr/src/minauthator/migrations/all.sql /usr/local/src/minauthator/migrations
|
|
||||||
COPY --from=builder /usr/src/minauthator/init_db.sh /usr/local/bin/minauthator_init_db.sh
|
|
||||||
COPY --from=builder /usr/src/minauthator/assets /usr/local/lib/minauthator/assets
|
|
||||||
|
|
||||||
RUN addgroup -g 1000 app && \
|
|
||||||
adduser -S -u 1000 -G app -s /bin/sh app && \
|
|
||||||
chown -R app:app /var/lib/minauthator && \
|
|
||||||
chmod -R u=rwx,g=rwx,o= /var/lib/minauthator
|
|
||||||
|
|
||||||
USER app:app
|
|
||||||
ENV RUST_LOG=info
|
|
||||||
ENV RUST_BACKTRACE=1
|
|
||||||
ENV APP_JWT_SECRET="DummyAppSecret20241029"
|
|
||||||
|
|
||||||
CMD ["minauthator-server", "--listen-host", "0.0.0.0", "--listen-port", "8080"]
|
|
||||||
|
|
||||||
|
|
||||||
662
LICENSE
662
LICENSE
|
|
@ -1,662 +0,0 @@
|
||||||
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/>.
|
|
||||||
|
|
||||||
51
README.md
51
README.md
|
|
@ -1,45 +1,24 @@
|
||||||
# Minauthator
|
# Minauthator
|
||||||
|
|
||||||
Minauthator is a self-hostable FOSS identity provider server supporting [OpenID Connect (OIDC)](https://en.wikipedia.org/wiki/OpenID_Connect).
|
Minauthator is an identity provider supporting [OpenID Connect (OIDC)](https://en.wikipedia.org/wiki/OpenID_Connect).
|
||||||
|
|
||||||
This project aims to allow an organization to setup [single sign-on (SSO)](https://en.wikipedia.org/wiki/Single_sign-on) using a self-hosted free software (FOSS).
|
This project aims to allow an organization to setup [single sign-on (SSO)](https://en.wikipedia.org/wiki/Single_sign-on) using a self-hosted free software.
|
||||||
|
|
||||||
This project also aims to provide features while being frugal and minimalist.
|
|
||||||
|
|
||||||
**Project status: *early development, work-in-progress***
|
**Project status: *early development, work-in-progress***
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- [x] Login
|
- Login
|
||||||
- [x] Register
|
- Register
|
||||||
- [x] OpenID Connect & OAuth 2.0
|
- OpenID Connect & OAuth 2.0
|
||||||
- [x] Activation token
|
- Activation token
|
||||||
- [x] Profile details
|
- Profile details
|
||||||
- [x] Static apps
|
- Static apps
|
||||||
- [x] Admin CLI to manage user.
|
- User roles
|
||||||
- [x] User invitation with human token
|
- MFA/TOTP
|
||||||
- [ ] User roles
|
- Email notifications
|
||||||
- [ ] User groups
|
- Login page customization
|
||||||
- [ ] MFA/TOTP
|
- App carousel (App presentation to users)
|
||||||
- [ ] Email notifications
|
|
||||||
- [ ] Login page customization
|
|
||||||
- [x] App listing (App presentation to users)
|
|
||||||
- [x] Implicit OAuth 2.0 flow
|
|
||||||
- [ ] Email verification
|
|
||||||
- [ ] GPG keys verification and signing
|
|
||||||
- [ ] Docker deployment
|
|
||||||
- [ ] Full user panel & user privacy control
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
- Sqlite DB
|
|
||||||
- Kernel
|
|
||||||
- Http server
|
|
||||||
- Public API
|
|
||||||
- User API
|
|
||||||
- Third-party OAuth2 app/client API
|
|
||||||
- Web GUI (no Javascript)
|
|
||||||
- Admin CLI
|
|
||||||
|
|
||||||
## Deps
|
## Deps
|
||||||
|
|
||||||
|
|
@ -49,8 +28,4 @@ This project also aims to provide features while being frugal and minimalist.
|
||||||
|
|
||||||
- [Authentik](https://goauthentik.io/)
|
- [Authentik](https://goauthentik.io/)
|
||||||
- [Keycloak](https://www.keycloak.org/)
|
- [Keycloak](https://www.keycloak.org/)
|
||||||
- [Kanidm](https://kanidm.com/)
|
|
||||||
|
|
||||||
## Licensing
|
|
||||||
|
|
||||||
This project is licensed under the [GNU Affero General Public License 3.0](https://www.gnu.org/licenses/agpl-3.0.en.html).
|
|
||||||
|
|
|
||||||
60
TODO.md
60
TODO.md
|
|
@ -1,33 +1,5 @@
|
||||||
# TODO
|
# TODO
|
||||||
|
|
||||||
- [ ] better OIDC support
|
|
||||||
- [ ] better support of `profile` `openid` `email` `roles` scopes
|
|
||||||
- [ ] support of custom id_token claims mapping/binding
|
|
||||||
- example for Vikunja: `vikunja_teams` or `vikunja_groups` attribute
|
|
||||||
- being able to say :
|
|
||||||
- For this client, I want to add this claim
|
|
||||||
- with the key X
|
|
||||||
- and the value taken from an expression
|
|
||||||
- eg "json_array(user.groups)"
|
|
||||||
|
|
||||||
- [ ] i18n strings in the HTTP website.
|
|
||||||
|
|
||||||
- [ ] Instance customization support
|
|
||||||
|
|
||||||
- [ ] Public endpoint to get user avatar by id
|
|
||||||
- [ ] Rework avatar upload to limit size and process the image?
|
|
||||||
|
|
||||||
- Authorize form
|
|
||||||
- [ ] Show details about permissions
|
|
||||||
- [ ] Show app logo
|
|
||||||
|
|
||||||
- [ ] Support error responses by https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1
|
|
||||||
|
|
||||||
- [ ] feat(perms): add groups and roles
|
|
||||||
|
|
||||||
- [ ] UserWebGUI: add TOTP
|
|
||||||
- [ ] send emails to users
|
|
||||||
|
|
||||||
- [x] Login form
|
- [x] Login form
|
||||||
- [x] Register form
|
- [x] Register form
|
||||||
- [x] Redirect to login form if unauthenticated
|
- [x] Redirect to login form if unauthenticated
|
||||||
|
|
@ -41,12 +13,20 @@
|
||||||
- [x] Support OpenID to use with demo client [oauth2c](https://github.com/cloudentity/oauth2c)
|
- [x] Support OpenID to use with demo client [oauth2c](https://github.com/cloudentity/oauth2c)
|
||||||
- .well-known/openid-configuration
|
- .well-known/openid-configuration
|
||||||
|
|
||||||
- [x] architecture refactor
|
|
||||||
- [x] AdminCLI: init
|
|
||||||
- [x] AdminCLI: list users
|
|
||||||
- [x] AdminCLI: create and invite user
|
|
||||||
|
|
||||||
- [x] UserWebGUI: Invitation
|
- [ ] i18n strings in the http website.
|
||||||
|
|
||||||
|
- [ ] App config
|
||||||
|
- Add app logo (URI?)
|
||||||
|
|
||||||
|
- [ ] Public endpoint to get user avatar by id
|
||||||
|
- [ ] Rework avatar upload to limit size and process the image?
|
||||||
|
|
||||||
|
- [ ] Authorize form
|
||||||
|
- Show details about permissions
|
||||||
|
- Show app logo
|
||||||
|
|
||||||
|
- [ ] Support error responses by https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1
|
||||||
|
|
||||||
- [x] UserWebGUI: Redirect to login when JWT expire
|
- [x] UserWebGUI: Redirect to login when JWT expire
|
||||||
- [x] UserWebGUI: Show user authorizations.
|
- [x] UserWebGUI: Show user authorizations.
|
||||||
|
|
@ -57,8 +37,14 @@
|
||||||
|
|
||||||
- [x] UserWebGUI: activate account with token
|
- [x] UserWebGUI: activate account with token
|
||||||
|
|
||||||
- [X] basic docker setup
|
- [ ] feat(perms): add groups and roles
|
||||||
- [ ] make `docker stop` working (handle SIGTERM/SIGINT)
|
|
||||||
- [ ] implement docker secrets. https://docs.docker.com/engine/swarm/secrets/
|
|
||||||
|
|
||||||
- [ ] Find a minimal OpenID client implementation like Listmonk but a little bit more mature
|
- [ ] UserWebGUI: add TOTP
|
||||||
|
- [ ] send emails to users
|
||||||
|
|
||||||
|
- Architecture: do we have an admin API?
|
||||||
|
|
||||||
|
- [ ] AdminCLI: init
|
||||||
|
- [ ] AdminWebGUI: List users
|
||||||
|
- [ ] AdminWebGUI: Assign groups to users
|
||||||
|
- [ ] AdminWebGUI: Create invitation
|
||||||
|
|
|
||||||
19
config.toml
19
config.toml
|
|
@ -1,23 +1,8 @@
|
||||||
signing_key = "tmp/secrets/signing.key"
|
|
||||||
|
|
||||||
[instance]
|
[instance]
|
||||||
base_uri = "https://auth.fictive.org"
|
base_uri = "http://localhost:8085"
|
||||||
name = "Fictive's auth"
|
name = "Example org"
|
||||||
logo_uri = "https://example.org/logo.png"
|
logo_uri = "https://example.org/logo.png"
|
||||||
|
|
||||||
[[applications]]
|
|
||||||
slug = "listmonk"
|
|
||||||
name = "Listmonk"
|
|
||||||
description = "Newsletter tool."
|
|
||||||
client_id = "da2120b4-635d-4eb5-8b2f-dbae89f6a6e9"
|
|
||||||
client_secret = "59da2291-8999-40e2-afe9-a54ac7cd0a94"
|
|
||||||
login_uri = "https://lists.fictive.org"
|
|
||||||
allowed_redirect_uris = [
|
|
||||||
"https://lists.fictive.org/auth/oidc",
|
|
||||||
]
|
|
||||||
visibility = "Internal"
|
|
||||||
authorize_flow = "Implicit"
|
|
||||||
|
|
||||||
[[applications]]
|
[[applications]]
|
||||||
slug = "demo_app"
|
slug = "demo_app"
|
||||||
name = "Demo app"
|
name = "Demo app"
|
||||||
|
|
|
||||||
10
init_db.sh
10
init_db.sh
|
|
@ -1,10 +0,0 @@
|
||||||
#!/bin/sh
|
|
||||||
|
|
||||||
DEFAULT_DB_PATH="/var/lib/minauthator/minauthator.db"
|
|
||||||
DEFAULT_MIGRATION_PATH="/usr/local/src/minauthator/migrations/all.sql"
|
|
||||||
|
|
||||||
DB_PATH="${DB_PATH:-$DEFAULT_DB_PATH}"
|
|
||||||
MIGRATION_PATH="${MIGRATION_PATH:-$DEFAULT_MIGRATION_PATH}"
|
|
||||||
|
|
||||||
sqlite3 $DB_PATH < $MIGRATION_PATH
|
|
||||||
|
|
||||||
40
justfile
40
justfile
|
|
@ -1,33 +1,25 @@
|
||||||
export RUST_BACKTRACE := "1"
|
export RUST_BACKTRACE := "1"
|
||||||
export RUST_LOG := "trace"
|
export RUST_LOG := "trace"
|
||||||
export CONTEXT_ARGS := "--config config.toml --database tmp/dbs/minauthator.db --static-assets ./assets"
|
export CONTEXT_ARGS := "--config ./config.toml --database ./tmp/dbs/minauthator.db --static-assets ./assets"
|
||||||
|
|
||||||
watch-server *args:
|
watch-server:
|
||||||
cargo-watch -x "run --bin minauthator-server -- $CONTEXT_ARGS {{args}}"
|
cargo-watch -x "run --bin minauthator-server -- $CONTEXT_ARGS"
|
||||||
|
|
||||||
server *args:
|
server:
|
||||||
cargo run --bin minauthator-server -- $CONTEXT_ARGS {{args}}
|
cargo run --bin minauthator-server -- $CONTEXT_ARGS
|
||||||
|
|
||||||
admin *args:
|
admin:
|
||||||
cargo run --bin minauthator-admin -- $CONTEXT_ARGS {{args}}
|
cargo run --bin minauthator-admin -- $CONTEXT_ARGS
|
||||||
|
|
||||||
docker-build *args:
|
|
||||||
docker build -t lefuturiste/minauthator {{args}} .
|
|
||||||
|
|
||||||
docker-init-db:
|
|
||||||
docker run \
|
|
||||||
-v ./tmp/docker/config:/etc/minauthator \
|
|
||||||
-v minauthator-db:/var/lib/minauthator \
|
|
||||||
lefuturiste/minauthator \
|
|
||||||
/usr/local/bin/minauthator_init_db.sh
|
|
||||||
|
|
||||||
docker-run:
|
docker-run:
|
||||||
docker run \
|
docker run -p 3085:8080 -v ./tmp/docker/config:/etc/minauthator -v ./tmp/docker/db:/var/lib/minauthator minauthator
|
||||||
-p 127.0.0.1:3085:8080 \
|
|
||||||
-v ./tmp/docker/config:/etc/minauthator \
|
|
||||||
-v minauthator-db:/var/lib/minauthator \
|
|
||||||
lefuturiste/minauthator
|
|
||||||
|
|
||||||
init-db *args:
|
docker-init-db:
|
||||||
sqlite3 {{args}} tmp/dbs/minauthator.db < migrations/all.sql
|
docker run -v ./tmp/docker/config:/etc/minauthator -v ./tmp/docker/db:/var/lib/minauthator minauthator /usr/local/bin/minauthator_init_db.sh
|
||||||
|
|
||||||
|
docker-build:
|
||||||
|
docker build -t minauthator .
|
||||||
|
|
||||||
|
init-db:
|
||||||
|
sqlite3 -echo tmp/dbs/minauthator.db < migrations/all.sql
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -44,14 +44,6 @@ sqlx = { workspace = true }
|
||||||
uuid = { workspace = true }
|
uuid = { workspace = true }
|
||||||
url = { workspace = true }
|
url = { workspace = true }
|
||||||
|
|
||||||
# To work with key pair
|
|
||||||
pem = "3.0.4"
|
|
||||||
|
|
||||||
[dependencies.jsonwebkey-convert-repaired]
|
|
||||||
git = "https://forge.lefuturiste.fr/rust-libs/jsonwebkey-rs-repaired.git"
|
|
||||||
branch = "master"
|
|
||||||
features = ["simple_asn1", "pem"]
|
|
||||||
|
|
||||||
[build-dependencies]
|
[build-dependencies]
|
||||||
minijinja-embed = "2.3.1"
|
minijinja-embed = "2.3.1"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,4 +2,3 @@ pub mod index;
|
||||||
pub mod oauth2;
|
pub mod oauth2;
|
||||||
pub mod read_user;
|
pub mod read_user;
|
||||||
pub mod openid;
|
pub mod openid;
|
||||||
pub mod public_assets;
|
|
||||||
|
|
|
||||||
|
|
@ -4,9 +4,9 @@ use fully_pub::fully_pub;
|
||||||
use log::error;
|
use log::error;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
use kernel::{models::authorization::Authorization, repositories::users::get_user_by_id};
|
use kernel::models::authorization::Authorization;
|
||||||
use crate::{
|
use crate::{
|
||||||
services::{app_session::AppClientSession, session::create_token}, token_claims::{OAuth2AccessTokenClaims, OIDCIdTokenClaims}, AppState
|
services::{app_session::AppClientSession, session::create_token}, token_claims::AppUserTokenClaims, AppState
|
||||||
};
|
};
|
||||||
|
|
||||||
const AUTHORIZATION_CODE_TTL_SECONDS: i64 = 120;
|
const AUTHORIZATION_CODE_TTL_SECONDS: i64 = 120;
|
||||||
|
|
@ -22,7 +22,6 @@ struct AccessTokenRequestParams {
|
||||||
#[derive(Serialize, Deserialize)]
|
#[derive(Serialize, Deserialize)]
|
||||||
#[fully_pub]
|
#[fully_pub]
|
||||||
struct AccessTokenResponse {
|
struct AccessTokenResponse {
|
||||||
id_token: String,
|
|
||||||
access_token: String,
|
access_token: String,
|
||||||
token_type: String,
|
token_type: String,
|
||||||
expires_in: u64
|
expires_in: u64
|
||||||
|
|
@ -61,7 +60,6 @@ pub async fn get_access_token(
|
||||||
).into_response();
|
).into_response();
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
// 2.2. Validate that the authorization code is not expired
|
// 2.2. Validate that the authorization code is not expired
|
||||||
let is_code_valid = authorization.last_used_at
|
let is_code_valid = authorization.last_used_at
|
||||||
.map_or(false, |ts| {
|
.map_or(false, |ts| {
|
||||||
|
|
@ -74,38 +72,19 @@ pub async fn get_access_token(
|
||||||
).into_response();
|
).into_response();
|
||||||
}
|
}
|
||||||
|
|
||||||
// 2.3. Fetch user resource owner
|
// 3. Generate JWT for oauth2 client user session
|
||||||
let user = get_user_by_id(&app_state.db, &authorization.user_id)
|
let jwt = create_token(
|
||||||
.await
|
|
||||||
.expect("Expected to get user from authorization.");
|
|
||||||
|
|
||||||
// 3.1. Generate JWT for OAuth2 client user session
|
|
||||||
let access_token_jwt = create_token(
|
|
||||||
&app_state.config,
|
|
||||||
&app_state.secrets,
|
&app_state.secrets,
|
||||||
OAuth2AccessTokenClaims::new(
|
AppUserTokenClaims::new(
|
||||||
&app_state.config,
|
&app_client_session.client_id,
|
||||||
&user,
|
&authorization.user_id,
|
||||||
authorization.scopes.to_vec()
|
authorization.scopes.to_vec()
|
||||||
)
|
)
|
||||||
);
|
);
|
||||||
// 3.2. Generate id_token for OIDC client
|
|
||||||
let id_token_claims = OIDCIdTokenClaims::new(
|
|
||||||
&app_state.config,
|
|
||||||
&app_client_session.client_id,
|
|
||||||
user.clone(),
|
|
||||||
authorization.nonce.clone()
|
|
||||||
);
|
|
||||||
let id_token_jwt = create_token(
|
|
||||||
&app_state.config,
|
|
||||||
&app_state.secrets,
|
|
||||||
id_token_claims
|
|
||||||
);
|
|
||||||
// 4. return JWT
|
// 4. return JWT
|
||||||
let access_token_res = AccessTokenResponse {
|
let access_token_res = AccessTokenResponse {
|
||||||
id_token: id_token_jwt,
|
access_token: jwt,
|
||||||
access_token: access_token_jwt,
|
token_type: "jwt".to_string(),
|
||||||
token_type: "Bearer".to_string(),
|
|
||||||
expires_in: 3600
|
expires_in: 3600
|
||||||
};
|
};
|
||||||
Json(access_token_res).into_response()
|
Json(access_token_res).into_response()
|
||||||
|
|
|
||||||
|
|
@ -1,46 +0,0 @@
|
||||||
use std::str::FromStr;
|
|
||||||
|
|
||||||
use jsonwebkey_convert_repaired::RSAPublicKey;
|
|
||||||
use jsonwebkey_convert_repaired::der::FromPem;
|
|
||||||
|
|
||||||
use axum::{extract::State, response::IntoResponse, Json};
|
|
||||||
use fully_pub::fully_pub;
|
|
||||||
use serde::Serialize;
|
|
||||||
|
|
||||||
use crate::AppState;
|
|
||||||
|
|
||||||
// /// JSON Web Key
|
|
||||||
// /// @See https://www.rfc-editor.org/rfc/rfc7517.html
|
|
||||||
// #[derive(Serialize)]
|
|
||||||
// #[fully_pub]
|
|
||||||
// struct RsaJWK {
|
|
||||||
// #[serde(rename = "use")]
|
|
||||||
// utilisation: String,
|
|
||||||
// alg: String,
|
|
||||||
// kid: String,
|
|
||||||
// #[serde(rename = "modulus")]
|
|
||||||
// modulus: String,
|
|
||||||
// exp: String
|
|
||||||
// }
|
|
||||||
|
|
||||||
/// JSON Web Key set
|
|
||||||
/// @See https://www.rfc-editor.org/rfc/rfc7517.html
|
|
||||||
#[derive(Serialize)]
|
|
||||||
#[fully_pub]
|
|
||||||
struct JWKs {
|
|
||||||
keys: Vec<RSAPublicKey>
|
|
||||||
}
|
|
||||||
|
|
||||||
pub async fn get_signing_public_keys(
|
|
||||||
State(app_state): State<AppState>,
|
|
||||||
) -> impl IntoResponse {
|
|
||||||
let pem_data = app_state.secrets.signing_keypair.0;
|
|
||||||
|
|
||||||
// extract modulus and exp number from ASN.1 encoded PCKS 1 package
|
|
||||||
let rsa_jwk = RSAPublicKey::from_pem(pem_data)
|
|
||||||
.expect("Failed to extract RSA public key from PEM");
|
|
||||||
|
|
||||||
Json(JWKs {
|
|
||||||
keys: vec![rsa_jwk]
|
|
||||||
}).into_response()
|
|
||||||
}
|
|
||||||
|
|
@ -1,2 +1 @@
|
||||||
pub mod well_known;
|
pub mod well_known;
|
||||||
pub mod keys;
|
|
||||||
|
|
|
||||||
|
|
@ -6,8 +6,6 @@ use strum::IntoEnumIterator;
|
||||||
|
|
||||||
use crate::AppState;
|
use crate::AppState;
|
||||||
|
|
||||||
/// Manifest used by OpenID Connect clients
|
|
||||||
/// @See https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
|
|
||||||
#[derive(Serialize)]
|
#[derive(Serialize)]
|
||||||
#[fully_pub]
|
#[fully_pub]
|
||||||
struct WellKnownOpenIdConfiguration {
|
struct WellKnownOpenIdConfiguration {
|
||||||
|
|
@ -17,9 +15,7 @@ struct WellKnownOpenIdConfiguration {
|
||||||
userinfo_endpoint: String,
|
userinfo_endpoint: String,
|
||||||
scopes_supported: Vec<String>,
|
scopes_supported: Vec<String>,
|
||||||
response_types_supported: Vec<String>,
|
response_types_supported: Vec<String>,
|
||||||
token_endpoint_auth_methods_supported: Vec<String>,
|
token_endpoint_auth_methods_supported: Vec<String>
|
||||||
id_token_signing_alg_values_supported: Vec<String>,
|
|
||||||
jwks_uri: String
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub async fn get_well_known_openid_configuration(
|
pub async fn get_well_known_openid_configuration(
|
||||||
|
|
@ -34,9 +30,5 @@ pub async fn get_well_known_openid_configuration(
|
||||||
scopes_supported: AuthorizationScope::iter().map(|v| v.to_string()).collect(),
|
scopes_supported: AuthorizationScope::iter().map(|v| v.to_string()).collect(),
|
||||||
response_types_supported: vec!["code".into()],
|
response_types_supported: vec!["code".into()],
|
||||||
token_endpoint_auth_methods_supported: vec!["client_secret_basic".into()],
|
token_endpoint_auth_methods_supported: vec!["client_secret_basic".into()],
|
||||||
id_token_signing_alg_values_supported: vec!["RS256".into()],
|
|
||||||
jwks_uri: format!("{}/.well-known/jwks", base_url)
|
|
||||||
// jwks_uri:
|
|
||||||
// subject_types_supported
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,27 +0,0 @@
|
||||||
use axum::{extract::{Path, State}, http::{header, HeaderMap, HeaderValue, StatusCode}, response::{Html, IntoResponse}};
|
|
||||||
use kernel::repositories::users::get_user_asset_by_id;
|
|
||||||
|
|
||||||
use crate::AppState;
|
|
||||||
|
|
||||||
pub async fn get_user_asset(
|
|
||||||
State(app_state): State<AppState>,
|
|
||||||
Path(asset_id): Path<String>
|
|
||||||
) -> impl IntoResponse {
|
|
||||||
let user_asset = match get_user_asset_by_id(&app_state.db, &asset_id).await {
|
|
||||||
Err(_) => {
|
|
||||||
return (
|
|
||||||
StatusCode::NOT_FOUND,
|
|
||||||
Html("Could not find user asset")
|
|
||||||
).into_response();
|
|
||||||
},
|
|
||||||
Ok(ua) => ua
|
|
||||||
};
|
|
||||||
|
|
||||||
let mut hm = HeaderMap::new();
|
|
||||||
hm.insert(
|
|
||||||
header::CONTENT_TYPE,
|
|
||||||
HeaderValue::from_str(&user_asset.mime_type).expect("Constructing header value.")
|
|
||||||
);
|
|
||||||
|
|
||||||
(hm, user_asset.content).into_response()
|
|
||||||
}
|
|
||||||
|
|
@ -2,7 +2,7 @@ use axum::{extract::State, response::IntoResponse, Extension, Json};
|
||||||
use fully_pub::fully_pub;
|
use fully_pub::fully_pub;
|
||||||
use serde::Serialize;
|
use serde::Serialize;
|
||||||
|
|
||||||
use crate::{token_claims::OAuth2AccessTokenClaims, AppState};
|
use crate::{token_claims::AppUserTokenClaims, AppState};
|
||||||
use kernel::models::user::User;
|
use kernel::models::user::User;
|
||||||
|
|
||||||
#[derive(Serialize)]
|
#[derive(Serialize)]
|
||||||
|
|
@ -18,11 +18,11 @@ struct ReadUserBasicExtract {
|
||||||
|
|
||||||
pub async fn read_user_basic(
|
pub async fn read_user_basic(
|
||||||
State(app_state): State<AppState>,
|
State(app_state): State<AppState>,
|
||||||
Extension(token_claims): Extension<OAuth2AccessTokenClaims>,
|
Extension(token_claims): Extension<AppUserTokenClaims>,
|
||||||
) -> impl IntoResponse {
|
) -> impl IntoResponse {
|
||||||
// 1. This handler require app user authentification (JWT)
|
// 1. This handler require app user authentification (JWT)
|
||||||
let user_res = sqlx::query_as::<_, User>("SELECT * FROM users WHERE id = $1")
|
let user_res = sqlx::query_as::<_, User>("SELECT * FROM users WHERE id = $1")
|
||||||
.bind(&token_claims.sub)
|
.bind(&token_claims.user_id)
|
||||||
.fetch_one(&app_state.db.0)
|
.fetch_one(&app_state.db.0)
|
||||||
.await
|
.await
|
||||||
.expect("To get user from claim");
|
.expect("To get user from claim");
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,9 @@ use serde::{Deserialize, Serialize};
|
||||||
use url::Url;
|
use url::Url;
|
||||||
use uuid::Uuid;
|
use uuid::Uuid;
|
||||||
|
|
||||||
use kernel::models::{authorization::Authorization, config::AppAuthorizeFlow};
|
use kernel::{
|
||||||
|
models::{authorization::Authorization, config::AppAuthorizeFlow}
|
||||||
|
};
|
||||||
use utils::get_random_alphanumerical;
|
use utils::get_random_alphanumerical;
|
||||||
use crate::{
|
use crate::{
|
||||||
renderer::TemplateRenderer, services::oauth2::{parse_scope, verify_redirect_uri}, token_claims::UserTokenClaims, AppState
|
renderer::TemplateRenderer, services::oauth2::{parse_scope, verify_redirect_uri}, token_claims::UserTokenClaims, AppState
|
||||||
|
|
@ -23,7 +25,6 @@ struct AuthorizationParams {
|
||||||
redirect_uri: String,
|
redirect_uri: String,
|
||||||
/// An opaque value used by the client to maintain state between the request and callback
|
/// An opaque value used by the client to maintain state between the request and callback
|
||||||
state: String,
|
state: String,
|
||||||
nonce: Option<String>
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn redirect_to_client(
|
fn redirect_to_client(
|
||||||
|
|
@ -33,7 +34,7 @@ fn redirect_to_client(
|
||||||
let target_url = format!("{}?code={}&state={}",
|
let target_url = format!("{}?code={}&state={}",
|
||||||
authorization_params.redirect_uri,
|
authorization_params.redirect_uri,
|
||||||
authorization_code,
|
authorization_code,
|
||||||
authorization_params.state
|
authorization_params.state,
|
||||||
);
|
);
|
||||||
debug!("Redirecting to {}", target_url);
|
debug!("Redirecting to {}", target_url);
|
||||||
|
|
||||||
|
|
@ -115,10 +116,9 @@ pub async fn authorize_form(
|
||||||
// Create new auth code
|
// Create new auth code
|
||||||
let authorization_code = get_random_alphanumerical(32);
|
let authorization_code = get_random_alphanumerical(32);
|
||||||
// Update last used timestamp for this authorization
|
// Update last used timestamp for this authorization
|
||||||
let _result = sqlx::query("UPDATE authorizations SET code = $2, nonce = $3, last_used_at = $4 WHERE id = $1")
|
let _result = sqlx::query("UPDATE authorizations SET code = $2, last_used_at = $3 WHERE id = $1")
|
||||||
.bind(existing_authorization.id)
|
.bind(existing_authorization.id)
|
||||||
.bind(authorization_code.clone())
|
.bind(authorization_code.clone())
|
||||||
.bind(authorization_params.nonce.clone())
|
|
||||||
.bind(Utc::now().to_rfc3339_opts(SecondsFormat::Millis, true))
|
.bind(Utc::now().to_rfc3339_opts(SecondsFormat::Millis, true))
|
||||||
.execute(&app_state.db.0)
|
.execute(&app_state.db.0)
|
||||||
.await.unwrap();
|
.await.unwrap();
|
||||||
|
|
@ -203,7 +203,6 @@ pub async fn perform_authorize(
|
||||||
client_id: app.client_id.clone(),
|
client_id: app.client_id.clone(),
|
||||||
scopes: sqlx::types::Json(scopes),
|
scopes: sqlx::types::Json(scopes),
|
||||||
code: authorization_code.clone(),
|
code: authorization_code.clone(),
|
||||||
nonce: authorize_form.nonce.clone(),
|
|
||||||
last_used_at: Some(Utc::now()),
|
last_used_at: Some(Utc::now()),
|
||||||
created_at: Utc::now(),
|
created_at: Utc::now(),
|
||||||
};
|
};
|
||||||
|
|
@ -211,15 +210,14 @@ pub async fn perform_authorize(
|
||||||
// 3. Save authorization in DB with state
|
// 3. Save authorization in DB with state
|
||||||
let res = sqlx::query("
|
let res = sqlx::query("
|
||||||
INSERT INTO authorizations
|
INSERT INTO authorizations
|
||||||
(id, user_id, client_id, scopes, code, nonce, last_used_at, created_at)
|
(id, user_id, client_id, scopes, code, last_used_at, created_at)
|
||||||
VALUES ($1, $2, $3, $4, $5, $6, $7, $8)
|
VALUES ($1, $2, $3, $4, $5, $6, $7)
|
||||||
")
|
")
|
||||||
.bind(authorization.id.clone())
|
.bind(authorization.id.clone())
|
||||||
.bind(authorization.user_id)
|
.bind(authorization.user_id)
|
||||||
.bind(authorization.client_id)
|
.bind(authorization.client_id)
|
||||||
.bind(authorization.scopes)
|
.bind(authorization.scopes)
|
||||||
.bind(authorization.code)
|
.bind(authorization.code)
|
||||||
.bind(authorization.nonce)
|
|
||||||
.bind(authorization.last_used_at.map(|x| x.to_rfc3339_opts(SecondsFormat::Millis, true)))
|
.bind(authorization.last_used_at.map(|x| x.to_rfc3339_opts(SecondsFormat::Millis, true)))
|
||||||
.bind(authorization.created_at.to_rfc3339_opts(SecondsFormat::Millis, true))
|
.bind(authorization.created_at.to_rfc3339_opts(SecondsFormat::Millis, true))
|
||||||
.execute(&app_state.db.0)
|
.execute(&app_state.db.0)
|
||||||
|
|
|
||||||
|
|
@ -91,8 +91,8 @@ pub async fn perform_login(
|
||||||
.await.unwrap();
|
.await.unwrap();
|
||||||
|
|
||||||
let jwt_max_age = Duration::days(15);
|
let jwt_max_age = Duration::days(15);
|
||||||
let claims = UserTokenClaims::new(&app_state.config, &user.id, jwt_max_age);
|
let claims = UserTokenClaims::new(&user.id, jwt_max_age);
|
||||||
let jwt = create_token(&app_state.config, &app_state.secrets, claims);
|
let jwt = create_token(&app_state.secrets, claims);
|
||||||
|
|
||||||
// TODO: handle keep_session boolean from form and specify cookie max age only if this setting
|
// TODO: handle keep_session boolean from form and specify cookie max age only if this setting
|
||||||
// is true
|
// is true
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,7 @@
|
||||||
use anyhow::Context;
|
|
||||||
use axum::{body::Bytes, extract::State, response::IntoResponse, Extension};
|
use axum::{body::Bytes, extract::State, response::IntoResponse, Extension};
|
||||||
use axum_typed_multipart::{FieldData, TryFromMultipart, TypedMultipart};
|
use axum_typed_multipart::{FieldData, TryFromMultipart, TypedMultipart};
|
||||||
use fully_pub::fully_pub;
|
use fully_pub::fully_pub;
|
||||||
use log::{error, info};
|
use log::error;
|
||||||
use minijinja::context;
|
use minijinja::context;
|
||||||
|
|
||||||
use crate::{
|
use crate::{
|
||||||
|
|
@ -10,7 +9,7 @@ use crate::{
|
||||||
renderer::TemplateRenderer,
|
renderer::TemplateRenderer,
|
||||||
AppState
|
AppState
|
||||||
};
|
};
|
||||||
use kernel::{models::{user::User, user_asset::UserAsset}, repositories::users::create_user_asset};
|
use kernel::models::user::User;
|
||||||
|
|
||||||
pub async fn me_page(
|
pub async fn me_page(
|
||||||
State(app_state): State<AppState>,
|
State(app_state): State<AppState>,
|
||||||
|
|
@ -62,7 +61,7 @@ struct UserDetailsUpdateForm {
|
||||||
website: String,
|
website: String,
|
||||||
|
|
||||||
#[form_data(limit = "5MiB")]
|
#[form_data(limit = "5MiB")]
|
||||||
avatar: FieldData<Bytes>
|
picture: FieldData<Bytes>
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -74,41 +73,17 @@ pub async fn me_perform_update_details(
|
||||||
) -> impl IntoResponse {
|
) -> impl IntoResponse {
|
||||||
let template_path = "pages/me/details-form";
|
let template_path = "pages/me/details-form";
|
||||||
|
|
||||||
let user = sqlx::query_as::<_, User>("SELECT * FROM users WHERE id = $1")
|
let update_res = sqlx::query("UPDATE users SET handle = $2, email = $3, full_name = $4, website = $5, picture = $6 WHERE id = $1")
|
||||||
.bind(&token_claims.sub)
|
|
||||||
.fetch_one(&app_state.db.0)
|
|
||||||
.await
|
|
||||||
.expect("To get user from claim");
|
|
||||||
|
|
||||||
let update_res = sqlx::query("UPDATE users SET handle = $2, email = $3, full_name = $4, website = $5 WHERE id = $1")
|
|
||||||
.bind(&token_claims.sub)
|
.bind(&token_claims.sub)
|
||||||
.bind(details_update.handle)
|
.bind(details_update.handle)
|
||||||
.bind(details_update.email)
|
.bind(details_update.email)
|
||||||
.bind(details_update.full_name)
|
.bind(details_update.full_name)
|
||||||
.bind(details_update.website)
|
.bind(details_update.website)
|
||||||
|
.bind(details_update.picture.contents.to_vec())
|
||||||
.execute(&app_state.db.0)
|
.execute(&app_state.db.0)
|
||||||
.await;
|
.await;
|
||||||
|
|
||||||
if !details_update.avatar.contents.is_empty() {
|
let user_res = sqlx::query_as::<_, User>("SELECT * FROM users WHERE id = $1")
|
||||||
let user_asset = UserAsset::new(
|
|
||||||
&user,
|
|
||||||
details_update.avatar.contents.to_vec(),
|
|
||||||
details_update.avatar.metadata.content_type.expect("Expected mimetype on avatar content"),
|
|
||||||
details_update.avatar.metadata.name
|
|
||||||
);
|
|
||||||
let _update_res = sqlx::query("UPDATE users SET avatar_asset_id = $2 WHERE id = $1")
|
|
||||||
.bind(&token_claims.sub)
|
|
||||||
.bind(user_asset.id.clone())
|
|
||||||
.execute(&app_state.db.0)
|
|
||||||
.await;
|
|
||||||
// TODO: handle possible error
|
|
||||||
let _ = create_user_asset(&app_state.db, user_asset)
|
|
||||||
.await
|
|
||||||
.context("Creating user avatar asset.");
|
|
||||||
info!("Uploaded new avatar as user asset");
|
|
||||||
}
|
|
||||||
|
|
||||||
let user = sqlx::query_as::<_, User>("SELECT * FROM users WHERE id = $1")
|
|
||||||
.bind(&token_claims.sub)
|
.bind(&token_claims.sub)
|
||||||
.fetch_one(&app_state.db.0)
|
.fetch_one(&app_state.db.0)
|
||||||
.await
|
.await
|
||||||
|
|
@ -120,7 +95,7 @@ pub async fn me_perform_update_details(
|
||||||
template_path,
|
template_path,
|
||||||
context!(
|
context!(
|
||||||
success => true,
|
success => true,
|
||||||
user => user
|
user => user_res
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
},
|
},
|
||||||
|
|
@ -130,7 +105,7 @@ pub async fn me_perform_update_details(
|
||||||
template_path,
|
template_path,
|
||||||
context!(
|
context!(
|
||||||
error => Some("Cannot update user details.".to_string()),
|
error => Some("Cannot update user details.".to_string()),
|
||||||
user => user
|
user => user_res
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -46,7 +46,7 @@ pub async fn perform_register(
|
||||||
email: Some(register.email),
|
email: Some(register.email),
|
||||||
handle: register.handle,
|
handle: register.handle,
|
||||||
full_name: None,
|
full_name: None,
|
||||||
avatar_asset_id: None,
|
picture: None,
|
||||||
|
|
||||||
password_hash,
|
password_hash,
|
||||||
status: UserStatus::Active,
|
status: UserStatus::Active,
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ use utils::parse_basic_auth;
|
||||||
|
|
||||||
use crate::{
|
use crate::{
|
||||||
services::{app_session::AppClientSession, session::verify_token},
|
services::{app_session::AppClientSession, session::verify_token},
|
||||||
token_claims::OAuth2AccessTokenClaims,
|
token_claims::AppUserTokenClaims,
|
||||||
AppState
|
AppState
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
@ -102,15 +102,14 @@ pub async fn enforce_jwt_auth_middleware(
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
let token_claims: OAuth2AccessTokenClaims =
|
let token_claims: AppUserTokenClaims = match verify_token(&app_state.secrets, jwt) {
|
||||||
match verify_token(&app_state.config, &app_state.secrets, jwt) {
|
Ok(val) => val,
|
||||||
Ok(val) => val,
|
Err(_e) => {
|
||||||
Err(_e) => {
|
return Err(
|
||||||
return Err(
|
(StatusCode::UNAUTHORIZED, Html("Unauthorized: The provided JWT is invalid."))
|
||||||
(StatusCode::UNAUTHORIZED, Html("Unauthorized: The provided JWT is invalid."))
|
);
|
||||||
);
|
}
|
||||||
}
|
};
|
||||||
};
|
|
||||||
req.extensions_mut().insert(token_claims);
|
req.extensions_mut().insert(token_claims);
|
||||||
Ok(next.run(req).await)
|
Ok(next.run(req).await)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -28,19 +28,18 @@ pub async fn auth_middleware(
|
||||||
return Ok(next.run(req).await)
|
return Ok(next.run(req).await)
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
let token_claims: UserTokenClaims =
|
let token_claims: UserTokenClaims = match verify_token(&app_state.secrets, jwt) {
|
||||||
match verify_token(&app_state.config, &app_state.secrets, jwt) {
|
Ok(val) => val,
|
||||||
Ok(val) => val,
|
Err(_e) => {
|
||||||
Err(_e) => {
|
// UserWebGUI: delete invalid JWT cookie
|
||||||
// UserWebGUI: delete invalid JWT cookie
|
return Err(
|
||||||
return Err(
|
(
|
||||||
(
|
cookies.remove(WEB_GUI_JWT_COOKIE_NAME),
|
||||||
cookies.remove(WEB_GUI_JWT_COOKIE_NAME),
|
Redirect::to(&original_uri.to_string())
|
||||||
Redirect::to(&original_uri.to_string())
|
)
|
||||||
)
|
);
|
||||||
);
|
}
|
||||||
}
|
};
|
||||||
};
|
|
||||||
req.extensions_mut().insert(token_claims);
|
req.extensions_mut().insert(token_claims);
|
||||||
Ok(next.run(req).await)
|
Ok(next.run(req).await)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -28,6 +28,7 @@ impl TemplateRenderer {
|
||||||
{
|
{
|
||||||
Ok(content) => Html(content).into_response(),
|
Ok(content) => Html(content).into_response(),
|
||||||
Err(err) => {
|
Err(err) => {
|
||||||
|
dbg!(err);
|
||||||
error!("FATAL: Failed to render template {}", name);
|
error!("FATAL: Failed to render template {}", name);
|
||||||
(StatusCode::INTERNAL_SERVER_ERROR, "Internal server error").into_response()
|
(StatusCode::INTERNAL_SERVER_ERROR, "Internal server error").into_response()
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -47,12 +47,10 @@ pub fn build_router(server_config: &ServerConfig, app_state: AppState) -> Router
|
||||||
let api_user_routes = Router::new()
|
let api_user_routes = Router::new()
|
||||||
.route("/api/user", get(api::read_user::read_user_basic))
|
.route("/api/user", get(api::read_user::read_user_basic))
|
||||||
.layer(middleware::from_fn_with_state(app_state.clone(), app_auth::enforce_jwt_auth_middleware))
|
.layer(middleware::from_fn_with_state(app_state.clone(), app_auth::enforce_jwt_auth_middleware))
|
||||||
.route("/api", get(api::index::get_index))
|
.route("/api", get(api::index::get_index));
|
||||||
.route("/api/user-assets/:asset_id", get(api::public_assets::get_user_asset));
|
|
||||||
|
|
||||||
let well_known_routes = Router::new()
|
let well_known_routes = Router::new()
|
||||||
.route("/.well-known/openid-configuration", get(api::openid::well_known::get_well_known_openid_configuration))
|
.route("/.well-known/openid-configuration", get(api::openid::well_known::get_well_known_openid_configuration));
|
||||||
.route("/.well-known/jwks", get(api::openid::keys::get_signing_public_keys));
|
|
||||||
|
|
||||||
Router::new()
|
Router::new()
|
||||||
.merge(public_routes)
|
.merge(public_routes)
|
||||||
|
|
|
||||||
|
|
@ -12,15 +12,9 @@ pub fn verify_redirect_uri(app: &Application, input_redirect_uri: &str) -> bool
|
||||||
pub fn parse_scope(scope_str: &str) -> Result<Vec<AuthorizationScope>> {
|
pub fn parse_scope(scope_str: &str) -> Result<Vec<AuthorizationScope>> {
|
||||||
let mut scopes: Vec<AuthorizationScope> = vec![];
|
let mut scopes: Vec<AuthorizationScope> = vec![];
|
||||||
for part in scope_str.split(' ') {
|
for part in scope_str.split(' ') {
|
||||||
if part == "openid" {
|
scopes.push(
|
||||||
scopes.push(AuthorizationScope::UserReadBasic);
|
AuthorizationScope::from_str(part).context("Cannot parse space-delimited scope.")?
|
||||||
scopes.push(AuthorizationScope::UserReadRoles);
|
)
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if part == "profile" || part == "email" {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
scopes.push(AuthorizationScope::from_str(part).context("Cannot parse space-delimited scope.")?);
|
|
||||||
}
|
}
|
||||||
Ok(scopes)
|
Ok(scopes)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,37 +1,24 @@
|
||||||
use anyhow::Result;
|
use anyhow::Result;
|
||||||
use serde::{de::DeserializeOwned, Serialize};
|
use serde::{de::DeserializeOwned, Serialize};
|
||||||
use jsonwebtoken::{encode, decode, Header, Algorithm, Validation, EncodingKey, DecodingKey};
|
use jsonwebtoken::{encode, decode, Header, Algorithm, Validation, EncodingKey, DecodingKey};
|
||||||
use kernel::{context::AppSecrets, models::config::Config};
|
use kernel::context::AppSecrets;
|
||||||
|
|
||||||
|
|
||||||
pub fn create_token<T: Serialize>(
|
pub fn create_token<T: Serialize>(secrets: &AppSecrets, claims: T) -> String {
|
||||||
_config: &Config,
|
|
||||||
secrets: &AppSecrets,
|
|
||||||
claims: T
|
|
||||||
) -> String {
|
|
||||||
let token = encode(
|
let token = encode(
|
||||||
&Header::new(Algorithm::RS256),
|
&Header::default(),
|
||||||
&claims,
|
&claims,
|
||||||
&EncodingKey::from_rsa_pem(&secrets.signing_keypair.1)
|
&EncodingKey::from_secret(secrets.jwt_secret.as_bytes())
|
||||||
.expect("To build encoding key from signing key.")
|
|
||||||
).expect("Create token");
|
).expect("Create token");
|
||||||
|
|
||||||
token
|
token
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn verify_token<T: DeserializeOwned>(
|
pub fn verify_token<T: DeserializeOwned>(secrets: &AppSecrets, jwt: &str) -> Result<T> {
|
||||||
config: &Config,
|
|
||||||
secrets: &AppSecrets,
|
|
||||||
jwt: &str
|
|
||||||
) -> Result<T> {
|
|
||||||
let mut validation = Validation::new(Algorithm::RS256);
|
|
||||||
validation.set_issuer(&[config.instance.base_uri.clone()]);
|
|
||||||
validation.set_audience(&[config.instance.base_uri.clone()]);
|
|
||||||
let token_data = decode::<T>(
|
let token_data = decode::<T>(
|
||||||
jwt,
|
jwt,
|
||||||
&DecodingKey::from_rsa_pem(&secrets.signing_keypair.0)
|
&DecodingKey::from_secret(secrets.jwt_secret.as_bytes()),
|
||||||
.expect("To build decoding key from signing key."),
|
&Validation::new(Algorithm::HS256)
|
||||||
&validation
|
|
||||||
)?;
|
)?;
|
||||||
|
|
||||||
Ok(token_data.claims)
|
Ok(token_data.claims)
|
||||||
|
|
|
||||||
|
|
@ -3,8 +3,7 @@
|
||||||
<h1>Bienvenue sur Minauthator</h1>
|
<h1>Bienvenue sur Minauthator</h1>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
Minauthator is free software under the
|
Minauthator is free software under <a href="https://www.gnu.org/licenses/gpl-3.0.txt">GPLv3</a> licence.
|
||||||
<a href="https://www.gnu.org/licenses/agpl-3.0.en.html">AGPLv3 licence</a>.
|
|
||||||
|
|
||||||
You can find source code on a <a href="https://forge.lefuturiste.fr/mbess/minauth">self-hosted forge repository</a>.
|
You can find source code on a <a href="https://forge.lefuturiste.fr/mbess/minauth">self-hosted forge repository</a>.
|
||||||
</p>
|
</p>
|
||||||
|
|
|
||||||
|
|
@ -55,9 +55,10 @@
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
<div class="mb-3">
|
<div class="mb-3">
|
||||||
<label for="avatar">Profile picture</label>
|
<label for="picture">Profile picture</label>
|
||||||
|
<!-- for now, no JPEG -->
|
||||||
<input
|
<input
|
||||||
id="avatar" name="avatar"
|
id="picture" name="picture"
|
||||||
type="file"
|
type="file"
|
||||||
accept="image/gif, image/png, image/jpeg"
|
accept="image/gif, image/png, image/jpeg"
|
||||||
class="form-control"
|
class="form-control"
|
||||||
|
|
|
||||||
|
|
@ -5,12 +5,9 @@
|
||||||
<a href="/me/details-form">Update details.</a>
|
<a href="/me/details-form">Update details.</a>
|
||||||
<a href="/me/authorizations">Manage authorizations.</a>
|
<a href="/me/authorizations">Manage authorizations.</a>
|
||||||
|
|
||||||
{% if user.avatar_asset_id %}
|
<p>
|
||||||
<div class="my-3">
|
{% if user.picture %}
|
||||||
<img
|
<img src="data:image/*;base64,{{ encode_b64str(user.picture) }}" style="width: 150px; height: 150px; object-fit: contain">
|
||||||
src="/api/user-assets/{{ user.avatar_asset_id }}"
|
|
||||||
style="width: 150px; height: 150px; object-fit: contain">
|
|
||||||
</div>
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
<ul>
|
<ul>
|
||||||
<li>
|
<li>
|
||||||
|
|
|
||||||
|
|
@ -9,9 +9,8 @@
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% if success %}
|
{% if success %}
|
||||||
<div class="alert alert-success">
|
<div class="alert alert-success">
|
||||||
If all the information you submitted are valid and unique,
|
If all the information you submitted are valid and unique, you're account
|
||||||
you're account has been created and
|
has been created and we've sent you a confirmation email.
|
||||||
we've sent you a confirmation email.
|
|
||||||
</div>
|
</div>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
<form id="register-form" method="post">
|
<form id="register-form" method="post">
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
use fully_pub::fully_pub;
|
use fully_pub::fully_pub;
|
||||||
use jsonwebtoken::get_current_timestamp;
|
use jsonwebtoken::get_current_timestamp;
|
||||||
use kernel::models::{authorization::AuthorizationScope, config::Config, user::User};
|
use kernel::models::authorization::AuthorizationScope;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use time::Duration;
|
use time::Duration;
|
||||||
|
|
||||||
|
|
@ -12,91 +12,41 @@ struct UserTokenClaims {
|
||||||
/// token expiration
|
/// token expiration
|
||||||
exp: u64,
|
exp: u64,
|
||||||
/// token issuer
|
/// token issuer
|
||||||
iss: String,
|
iss: String
|
||||||
// TODO: add roles
|
// TODO: add roles
|
||||||
/// token audience
|
|
||||||
aud: String
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl UserTokenClaims {
|
impl UserTokenClaims {
|
||||||
pub fn new(config: &Config, user_id: &str, max_age: Duration) -> Self {
|
pub fn new(user_id: &str, max_age: Duration) -> Self {
|
||||||
UserTokenClaims {
|
UserTokenClaims {
|
||||||
sub: user_id.into(),
|
sub: user_id.into(),
|
||||||
exp: get_current_timestamp() + max_age.whole_seconds() as u64,
|
exp: get_current_timestamp() + max_age.whole_seconds() as u64,
|
||||||
iss: config.instance.base_uri.clone(),
|
iss: "Minauthator".into()
|
||||||
aud: config.instance.base_uri.clone(),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Access token for OAuth2 defined in RFC 9068
|
|
||||||
/// @See https://datatracker.ietf.org/doc/html/rfc9068
|
|
||||||
#[derive(Debug, Serialize, Deserialize, Clone)]
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
||||||
#[fully_pub]
|
#[fully_pub]
|
||||||
struct OAuth2AccessTokenClaims {
|
struct AppUserTokenClaims {
|
||||||
/// Token issuer (URI to the issuer)
|
/// combined subject
|
||||||
iss: String,
|
client_id: String,
|
||||||
/// Audiance (In this case, the audiance is equal to the issuer)
|
user_id: String,
|
||||||
aud: String,
|
scopes: Vec<AuthorizationScope>,
|
||||||
/// End-user id assigned by the issuer (user_id)
|
/// token expiration
|
||||||
sub: String,
|
|
||||||
/// Token expiration
|
|
||||||
exp: u64,
|
exp: u64,
|
||||||
/// List of OAuth 2 scopes asked by the client
|
/// token issuer
|
||||||
scopes: Vec<AuthorizationScope>
|
iss: String
|
||||||
}
|
}
|
||||||
|
|
||||||
impl OAuth2AccessTokenClaims {
|
impl AppUserTokenClaims {
|
||||||
pub fn new(config: &Config, user: &User, scopes: Vec<AuthorizationScope>) -> Self {
|
pub fn new(client_id: &str, user_id: &str, scopes: Vec<AuthorizationScope>) -> Self {
|
||||||
OAuth2AccessTokenClaims {
|
AppUserTokenClaims {
|
||||||
iss: config.instance.base_uri.clone(),
|
client_id: client_id.into(),
|
||||||
aud: config.instance.base_uri.clone(),
|
user_id: user_id.into(),
|
||||||
sub: user.id.clone(),
|
|
||||||
exp: get_current_timestamp() + 86_000,
|
|
||||||
scopes,
|
scopes,
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/// @See https://openid.net/specs/openid-connect-core-1_0.html#IDToken
|
|
||||||
/// @See https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
|
|
||||||
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
||||||
#[fully_pub]
|
|
||||||
struct OIDCIdTokenClaims {
|
|
||||||
/// Token expiration
|
|
||||||
exp: u64,
|
|
||||||
/// Token issuer (URI to the issuer)
|
|
||||||
iss: String,
|
|
||||||
/// Audiance (client_id)
|
|
||||||
aud: String,
|
|
||||||
/// End-user id assigned by the issuer (user_id)
|
|
||||||
sub: String,
|
|
||||||
/// additional claims
|
|
||||||
name: Option<String>,
|
|
||||||
email: Option<String>,
|
|
||||||
preferred_username: Option<String>,
|
|
||||||
roles: Vec<String>,
|
|
||||||
nonce: Option<String>
|
|
||||||
}
|
|
||||||
|
|
||||||
impl OIDCIdTokenClaims {
|
|
||||||
pub fn new(
|
|
||||||
config: &Config,
|
|
||||||
client_id: &str,
|
|
||||||
user: User,
|
|
||||||
nonce: Option<String>
|
|
||||||
) -> Self {
|
|
||||||
OIDCIdTokenClaims {
|
|
||||||
iss: config.instance.base_uri.clone(),
|
|
||||||
aud: client_id.into(),
|
|
||||||
sub: user.id,
|
|
||||||
exp: get_current_timestamp() + 86_000,
|
exp: get_current_timestamp() + 86_000,
|
||||||
email: user.email,
|
iss: "Minauth".into()
|
||||||
name: user.full_name,
|
|
||||||
preferred_username: Some(user.handle),
|
|
||||||
roles: user.roles.0,
|
|
||||||
nonce
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -18,8 +18,6 @@ chrono = { workspace = true }
|
||||||
toml = { workspace = true }
|
toml = { workspace = true }
|
||||||
sqlx = { workspace = true }
|
sqlx = { workspace = true }
|
||||||
dotenvy = { workspace = true }
|
dotenvy = { workspace = true }
|
||||||
sha2 = { workspace = true }
|
|
||||||
hex-literal = { workspace = true }
|
|
||||||
|
|
||||||
uuid = { workspace = true }
|
uuid = { workspace = true }
|
||||||
url = { workspace = true }
|
url = { workspace = true }
|
||||||
|
|
|
||||||
|
|
@ -35,6 +35,7 @@ pub async fn create_user(ctx: KernelContext, user: User) -> Result<(), CreateUse
|
||||||
if db_err.code().unwrap() == "2067" {
|
if db_err.code().unwrap() == "2067" {
|
||||||
Err(CreateUserErr::HandleOrEmailNotUnique)
|
Err(CreateUserErr::HandleOrEmailNotUnique)
|
||||||
} else {
|
} else {
|
||||||
|
dbg!(&err);
|
||||||
Err(CreateUserErr::DatabaseErr(db_err.to_string()))
|
Err(CreateUserErr::DatabaseErr(db_err.to_string()))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,4 @@
|
||||||
pub const DEFAULT_DB_PATH: &str = "/var/lib/minauthator/minauthator.db";
|
pub const DEFAULT_DB_PATH: &str = "/var/lib/minauthator/minauthator.db";
|
||||||
pub const DEFAULT_ASSETS_PATH: &str = "/usr/local/lib/minauthator/assets";
|
pub const DEFAULT_ASSETS_PATH: &str = "/usr/local/lib/minauthator/assets";
|
||||||
pub const DEFAULT_CONFIG_PATH: &str = "/etc/minauthator/config.toml";
|
pub const DEFAULT_CONFIG_PATH: &str = "/etc/minauthator/config.yaml";
|
||||||
pub const DEFAULT_SIGNING_KEY_PATH: &str = "/etc/minauthator/secrets/jwt.key.pem";
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,13 +1,11 @@
|
||||||
use std::{env, fs, path::Path};
|
use std::{env, fs};
|
||||||
use anyhow::{Result, Context, anyhow};
|
use anyhow::{Result, Context, anyhow};
|
||||||
use fully_pub::fully_pub;
|
use fully_pub::fully_pub;
|
||||||
|
|
||||||
use log::info;
|
use log::info;
|
||||||
|
use sqlx::{Pool, Sqlite};
|
||||||
use crate::{
|
use crate::{
|
||||||
consts::{DEFAULT_CONFIG_PATH, DEFAULT_DB_PATH, DEFAULT_SIGNING_KEY_PATH},
|
consts::{DEFAULT_CONFIG_PATH, DEFAULT_DB_PATH}, database::prepare_database, models::config::Config, repositories::storage::Storage
|
||||||
database::prepare_database,
|
|
||||||
models::config::Config,
|
|
||||||
repositories::storage::Storage
|
|
||||||
};
|
};
|
||||||
|
|
||||||
/// get server config
|
/// get server config
|
||||||
|
|
@ -28,18 +26,9 @@ struct StartKernelConfig {
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
#[fully_pub]
|
#[fully_pub]
|
||||||
struct AppSecrets {
|
struct AppSecrets {
|
||||||
/// RSA keypair (public, private) used to signed the JWT issued by minauthator in PEM conainer format
|
jwt_secret: String
|
||||||
signing_keypair: (Vec<u8>, Vec<u8>)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone)]
|
|
||||||
#[fully_pub]
|
|
||||||
struct ComputedConfig {
|
|
||||||
signing_public_key: Vec<u8>,
|
|
||||||
signing_private_key: Vec<u8>
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
#[fully_pub]
|
#[fully_pub]
|
||||||
struct KernelContext {
|
struct KernelContext {
|
||||||
|
|
@ -48,19 +37,6 @@ struct KernelContext {
|
||||||
storage: Storage
|
storage: Storage
|
||||||
}
|
}
|
||||||
|
|
||||||
fn get_signing_keypair(key_path: &str) -> Result<(Vec<u8>, Vec<u8>)> {
|
|
||||||
let key_path = Path::new(key_path);
|
|
||||||
let pub_key_path = key_path.with_extension("pub");
|
|
||||||
let private_key: Vec<u8> = fs::read_to_string(&key_path)
|
|
||||||
.context(format!("Failed to read private key from path {:?}.", key_path))?
|
|
||||||
.as_bytes().to_vec();
|
|
||||||
let public_key: Vec<u8> = fs::read_to_string(&pub_key_path)
|
|
||||||
.context(format!("Failed to read public key from path {:?}.", pub_key_path))?
|
|
||||||
.as_bytes().to_vec();
|
|
||||||
|
|
||||||
Ok((public_key, private_key))
|
|
||||||
}
|
|
||||||
|
|
||||||
pub async fn get_kernel_context(start_config: StartKernelConfig) -> Result<KernelContext> {
|
pub async fn get_kernel_context(start_config: StartKernelConfig) -> Result<KernelContext> {
|
||||||
env_logger::init();
|
env_logger::init();
|
||||||
let _ = dotenvy::dotenv();
|
let _ = dotenvy::dotenv();
|
||||||
|
|
@ -74,13 +50,9 @@ pub async fn get_kernel_context(start_config: StartKernelConfig) -> Result<Kerne
|
||||||
let config: Config = get_config(config_path)
|
let config: Config = get_config(config_path)
|
||||||
.expect("Cannot get config.");
|
.expect("Cannot get config.");
|
||||||
|
|
||||||
let signing_key_path = config.signing_key.clone().unwrap_or(DEFAULT_SIGNING_KEY_PATH.to_string());
|
dotenvy::dotenv().context("loading .env")?;
|
||||||
|
|
||||||
// optionally load dotenv file
|
|
||||||
let _ = dotenvy::dotenv();
|
|
||||||
|
|
||||||
let secrets = AppSecrets {
|
let secrets = AppSecrets {
|
||||||
signing_keypair: get_signing_keypair(&signing_key_path)?
|
jwt_secret: env::var("APP_JWT_SECRET").context("Expecting APP_JWT_SECRET env var.")?
|
||||||
};
|
};
|
||||||
|
|
||||||
Ok(KernelContext {
|
Ok(KernelContext {
|
||||||
|
|
|
||||||
|
|
@ -25,8 +25,6 @@ struct Authorization {
|
||||||
client_id: String,
|
client_id: String,
|
||||||
scopes: Json<Vec<AuthorizationScope>>,
|
scopes: Json<Vec<AuthorizationScope>>,
|
||||||
|
|
||||||
nonce: Option<String>,
|
|
||||||
|
|
||||||
/// defined in https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2
|
/// defined in https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2
|
||||||
code: String,
|
code: String,
|
||||||
last_used_at: Option<DateTime<Utc>>,
|
last_used_at: Option<DateTime<Utc>>,
|
||||||
|
|
|
||||||
|
|
@ -66,6 +66,11 @@ struct Role {
|
||||||
struct Config {
|
struct Config {
|
||||||
instance: InstanceConfig,
|
instance: InstanceConfig,
|
||||||
applications: Vec<Application>,
|
applications: Vec<Application>,
|
||||||
roles: Vec<Role>,
|
roles: Vec<Role>
|
||||||
signing_key: Option<String>
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone)]
|
||||||
|
#[fully_pub]
|
||||||
|
struct AppSecrets {
|
||||||
|
jwt_secret: String
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,3 @@
|
||||||
pub mod config;
|
pub mod config;
|
||||||
pub mod user;
|
pub mod user;
|
||||||
pub mod user_asset;
|
|
||||||
pub mod authorization;
|
pub mod authorization;
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ enum UserStatus {
|
||||||
Active
|
Active
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(sqlx::FromRow, Deserialize, Serialize, Debug, Clone)]
|
#[derive(sqlx::FromRow, Deserialize, Serialize, Debug)]
|
||||||
#[fully_pub]
|
#[fully_pub]
|
||||||
struct User {
|
struct User {
|
||||||
/// uuid
|
/// uuid
|
||||||
|
|
@ -23,7 +23,7 @@ struct User {
|
||||||
full_name: Option<String>,
|
full_name: Option<String>,
|
||||||
email: Option<String>,
|
email: Option<String>,
|
||||||
website: Option<String>,
|
website: Option<String>,
|
||||||
avatar_asset_id: Option<String>,
|
picture: Option<Vec<u8>>, // embeded blob to store profile pic
|
||||||
password_hash: Option<String>, // argon2 password hash
|
password_hash: Option<String>, // argon2 password hash
|
||||||
status: UserStatus,
|
status: UserStatus,
|
||||||
roles: Json<Vec<String>>,
|
roles: Json<Vec<String>>,
|
||||||
|
|
@ -43,7 +43,7 @@ impl User {
|
||||||
full_name: None,
|
full_name: None,
|
||||||
email: None,
|
email: None,
|
||||||
website: None,
|
website: None,
|
||||||
avatar_asset_id: None,
|
picture: None,
|
||||||
password_hash: None,
|
password_hash: None,
|
||||||
status: UserStatus::Disabled,
|
status: UserStatus::Disabled,
|
||||||
roles: Json(Vec::new()),
|
roles: Json(Vec::new()),
|
||||||
|
|
|
||||||
|
|
@ -1,41 +0,0 @@
|
||||||
use fully_pub::fully_pub;
|
|
||||||
use chrono::{DateTime, Utc};
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
use uuid::Uuid;
|
|
||||||
use sha2::{Sha256, Digest};
|
|
||||||
|
|
||||||
use super::user::User;
|
|
||||||
|
|
||||||
|
|
||||||
#[derive(sqlx::FromRow, Deserialize, Serialize, Debug)]
|
|
||||||
#[fully_pub]
|
|
||||||
struct UserAsset {
|
|
||||||
/// uuid
|
|
||||||
id: String,
|
|
||||||
user_id: String,
|
|
||||||
mime_type: String,
|
|
||||||
fingerprint: String,
|
|
||||||
name: Option<String>,
|
|
||||||
content: Vec<u8>,
|
|
||||||
created_at: DateTime<Utc>
|
|
||||||
}
|
|
||||||
|
|
||||||
impl UserAsset {
|
|
||||||
pub fn new(
|
|
||||||
user: &User,
|
|
||||||
content: Vec<u8>,
|
|
||||||
mime_type: String,
|
|
||||||
name: Option<String>
|
|
||||||
) -> UserAsset {
|
|
||||||
let digest = Sha256::digest(&content);
|
|
||||||
UserAsset {
|
|
||||||
id: Uuid::new_v4().to_string(),
|
|
||||||
user_id: user.id.clone(),
|
|
||||||
fingerprint: format!("{:x}", digest),
|
|
||||||
mime_type,
|
|
||||||
content,
|
|
||||||
name,
|
|
||||||
created_at: Utc::now()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
// user repositories
|
// user repositories
|
||||||
|
|
||||||
use crate::models::{user::User, user_asset::UserAsset};
|
use crate::models::user::User;
|
||||||
|
|
||||||
use super::storage::Storage;
|
use super::storage::Storage;
|
||||||
use anyhow::{Result, Context};
|
use anyhow::{Result, Context};
|
||||||
|
|
@ -19,30 +19,3 @@ pub async fn get_users(storage: &Storage) -> Result<Vec<User>> {
|
||||||
.await
|
.await
|
||||||
.context("To get users.")
|
.context("To get users.")
|
||||||
}
|
}
|
||||||
|
|
||||||
pub async fn create_user_asset(storage: &Storage, asset: UserAsset) -> Result<()> {
|
|
||||||
sqlx::query("INSERT INTO user_assets
|
|
||||||
(id, user_id, mime_type, fingerprint, content, created_at)
|
|
||||||
VALUES ($1, $2, $3, $4, $5, $6)
|
|
||||||
")
|
|
||||||
.bind(&asset.id)
|
|
||||||
.bind(&asset.user_id)
|
|
||||||
.bind(&asset.mime_type)
|
|
||||||
.bind(&asset.fingerprint)
|
|
||||||
.bind(&asset.content)
|
|
||||||
.bind(&asset.created_at)
|
|
||||||
.execute(&storage.0)
|
|
||||||
.await
|
|
||||||
.context("While inserting user asset.")?;
|
|
||||||
// .bind(details_update.avatar.contents.to_vec())
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
pub async fn get_user_asset_by_id(storage: &Storage, id: &str) -> Result<UserAsset> {
|
|
||||||
sqlx::query_as("SELECT * FROM user_assets WHERE id = $1")
|
|
||||||
.bind(id)
|
|
||||||
.fetch_one(&storage.0)
|
|
||||||
.await
|
|
||||||
.context("To get user asset by id.")
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,8 +5,8 @@ CREATE TABLE users (
|
||||||
full_name TEXT,
|
full_name TEXT,
|
||||||
email TEXT UNIQUE,
|
email TEXT UNIQUE,
|
||||||
website TEXT,
|
website TEXT,
|
||||||
|
picture BLOB,
|
||||||
roles TEXT NOT NULL, -- json array of user roles
|
roles TEXT NOT NULL, -- json array of user roles
|
||||||
avatar_asset_id TEXT,
|
|
||||||
|
|
||||||
status TEXT CHECK(status IN ('Invited', 'Active', 'Disabled')) NOT NULL DEFAULT 'Disabled',
|
status TEXT CHECK(status IN ('Invited', 'Active', 'Disabled')) NOT NULL DEFAULT 'Disabled',
|
||||||
password_hash TEXT,
|
password_hash TEXT,
|
||||||
|
|
@ -15,17 +15,6 @@ CREATE TABLE users (
|
||||||
created_at DATETIME NOT NULL
|
created_at DATETIME NOT NULL
|
||||||
);
|
);
|
||||||
|
|
||||||
DROP TABLE IF EXISTS user_assets;
|
|
||||||
CREATE TABLE user_assets (
|
|
||||||
id TEXT PRIMARY KEY,
|
|
||||||
user_id TEXT NOT NULL,
|
|
||||||
mime_type TEXT NOT NULL,
|
|
||||||
fingerprint TEXT NOT NULL,
|
|
||||||
name TEXT, -- file name
|
|
||||||
content BLOB NOT NULL,
|
|
||||||
created_at DATETIME NOT NULL
|
|
||||||
);
|
|
||||||
|
|
||||||
DROP TABLE IF EXISTS authorizations;
|
DROP TABLE IF EXISTS authorizations;
|
||||||
CREATE TABLE authorizations (
|
CREATE TABLE authorizations (
|
||||||
id TEXT PRIMARY KEY,
|
id TEXT PRIMARY KEY,
|
||||||
|
|
@ -33,7 +22,6 @@ CREATE TABLE authorizations (
|
||||||
client_id TEXT NOT NULL,
|
client_id TEXT NOT NULL,
|
||||||
scopes TEXT, -- json array of app scope (permissions)
|
scopes TEXT, -- json array of app scope (permissions)
|
||||||
code TEXT,
|
code TEXT,
|
||||||
nonce TEXT, -- code used to associate client session to id_token
|
|
||||||
|
|
||||||
last_used_at DATETIME,
|
last_used_at DATETIME,
|
||||||
created_at DATETIME NOT NULL
|
created_at DATETIME NOT NULL
|
||||||
|
|
|
||||||
|
|
@ -1,12 +0,0 @@
|
||||||
#!/usr/bin/sh
|
|
||||||
|
|
||||||
set -eou pipefail
|
|
||||||
|
|
||||||
project_root="$(dirname $(cargo locate-project | jq -r .root))"
|
|
||||||
scenarios_dir="$project_root/tests/hurl_integration/scenarios"
|
|
||||||
|
|
||||||
ls -1 $scenarios_dir | while read line
|
|
||||||
do
|
|
||||||
$project_root/tests/hurl_integration/run_scenario.sh $line
|
|
||||||
done
|
|
||||||
|
|
||||||
|
|
@ -4,7 +4,7 @@ set -eou pipefail
|
||||||
|
|
||||||
scenario_name="$1"
|
scenario_name="$1"
|
||||||
project_root="$(dirname $(cargo locate-project | jq -r .root))"
|
project_root="$(dirname $(cargo locate-project | jq -r .root))"
|
||||||
scenario_dir="$project_root/tests/hurl_integration/scenarios/$scenario_name"
|
scenario_dir="$project_root/tests/hurl_integration/$1"
|
||||||
scenario_tmp_dir_path="$project_root/tmp/tests/$scenario_name"
|
scenario_tmp_dir_path="$project_root/tmp/tests/$scenario_name"
|
||||||
database_path="$project_root/tmp/tests/$scenario_name/minauthator.db"
|
database_path="$project_root/tmp/tests/$scenario_name/minauthator.db"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,3 @@
|
||||||
signing_key = "tmp/secrets/signing.key"
|
|
||||||
|
|
||||||
[instance]
|
[instance]
|
||||||
base_uri = "http://localhost:8086"
|
base_uri = "http://localhost:8086"
|
||||||
name = "Example org"
|
name = "Example org"
|
||||||
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
|
|
@ -3,7 +3,6 @@ HTTP 200
|
||||||
[Asserts]
|
[Asserts]
|
||||||
jsonpath "$.software" == "Minauthator"
|
jsonpath "$.software" == "Minauthator"
|
||||||
|
|
||||||
# Login into account
|
|
||||||
POST {{ base_url }}/login
|
POST {{ base_url }}/login
|
||||||
[FormParams]
|
[FormParams]
|
||||||
login: root
|
login: root
|
||||||
|
|
@ -16,24 +15,21 @@ cookie "minauthator_jwt" exists
|
||||||
cookie "minauthator_jwt[Value]" contains "eyJ0"
|
cookie "minauthator_jwt[Value]" contains "eyJ0"
|
||||||
cookie "minauthator_jwt[SameSite]" == "Lax"
|
cookie "minauthator_jwt[SameSite]" == "Lax"
|
||||||
|
|
||||||
# Get current details
|
|
||||||
GET {{ base_url }}/me
|
GET {{ base_url }}/me
|
||||||
HTTP 200
|
HTTP 200
|
||||||
Content-Type: text/html; charset=utf-8
|
Content-Type: text/html; charset=utf-8
|
||||||
[Asserts]
|
[Asserts]
|
||||||
xpath "string(///h1)" == "Welcome root!"
|
xpath "string(///h1)" == "Welcome root!"
|
||||||
|
|
||||||
# Change the profile picture
|
|
||||||
POST {{ base_url }}/me/details-form
|
POST {{ base_url }}/me/details-form
|
||||||
[MultipartFormData]
|
[MultipartFormData]
|
||||||
handle: root
|
handle: root
|
||||||
email: root@johndoe.net
|
email: root@johndoe.net
|
||||||
full_name: John Doe
|
full_name: John Doe
|
||||||
website: https://johndoe.net
|
website: https://johndoe.net
|
||||||
avatar: file,john_doe_profile_pic.jpg; image/jpeg
|
picture: file,john_doe_profile_pic.jpg; image/jpeg
|
||||||
HTTP 200
|
HTTP 200
|
||||||
|
|
||||||
# Assert that we have currently no authorizations
|
|
||||||
GET {{ base_url }}/me/authorizations
|
GET {{ base_url }}/me/authorizations
|
||||||
HTTP 200
|
HTTP 200
|
||||||
[Asserts]
|
[Asserts]
|
||||||
|
|
@ -80,6 +76,12 @@ Content-Type: application/json
|
||||||
jsonpath "$.handle" == "root"
|
jsonpath "$.handle" == "root"
|
||||||
jsonpath "$.email" == "root@johndoe.net"
|
jsonpath "$.email" == "root@johndoe.net"
|
||||||
|
|
||||||
|
GET {{ base_url }}/me/authorizations
|
||||||
|
HTTP 200
|
||||||
|
[Asserts]
|
||||||
|
xpath "string(///h1)" == "Your authorizations"
|
||||||
|
xpath "string(///main/ul/li)" contains "UserReadBasic"
|
||||||
|
|
||||||
GET {{ base_url }}/logout
|
GET {{ base_url }}/logout
|
||||||
HTTP 303
|
HTTP 303
|
||||||
[Asserts]
|
[Asserts]
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
signing_key = "tmp/secrets/signing.key"
|
|
||||||
|
|
||||||
[instance]
|
|
||||||
base_uri = "http://localhost:8086"
|
|
||||||
name = "Example org"
|
|
||||||
logo_uri = "https://example.org/logo.png"
|
|
||||||
|
|
||||||
[[applications]]
|
|
||||||
slug = "demo_app"
|
|
||||||
name = "Demo app"
|
|
||||||
description = "A super application where you can do everything you want."
|
|
||||||
client_id = "00000001-0000-0000-0000-000000000001"
|
|
||||||
client_secret = "dummy_client_secret"
|
|
||||||
login_uri = "https://localhost:9876"
|
|
||||||
allowed_redirect_uris = [
|
|
||||||
"http://localhost:9090/callback",
|
|
||||||
"http://localhost:9876/callback"
|
|
||||||
]
|
|
||||||
visibility = "Internal"
|
|
||||||
authorize_flow = "Implicit"
|
|
||||||
|
|
||||||
[[roles]]
|
|
||||||
slug = "basic"
|
|
||||||
name = "Basic"
|
|
||||||
description = "Basic user"
|
|
||||||
default = true
|
|
||||||
|
|
||||||
[[roles]]
|
|
||||||
slug = "admin"
|
|
||||||
name = "Administrator"
|
|
||||||
description = "Full power on organization instance"
|
|
||||||
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
#!/usr/bin/bash
|
|
||||||
|
|
||||||
password_hash="$(echo -n "root" | argon2 salt_06cGGWYDJCZ -e)"
|
|
||||||
echo $password_hash
|
|
||||||
SQL=$(cat <<EOF
|
|
||||||
INSERT INTO users
|
|
||||||
(id, handle, email, roles, status, password_hash, created_at)
|
|
||||||
VALUES
|
|
||||||
('$(uuid)', 'root', 'root@example.org', '[]', 'Active', '$password_hash', '2024-11-30T00:00:00Z');
|
|
||||||
EOF)
|
|
||||||
echo $SQL | sqlite3 $DB_PATH
|
|
||||||
|
|
@ -1,52 +0,0 @@
|
||||||
# Login into account
|
|
||||||
POST {{ base_url }}/login
|
|
||||||
[FormParams]
|
|
||||||
login: root
|
|
||||||
password: root
|
|
||||||
HTTP 303
|
|
||||||
[Captures]
|
|
||||||
user_jwt: cookie "minauthator_jwt"
|
|
||||||
[Asserts]
|
|
||||||
cookie "minauthator_jwt" exists
|
|
||||||
cookie "minauthator_jwt[Value]" contains "eyJ0"
|
|
||||||
cookie "minauthator_jwt[SameSite]" == "Lax"
|
|
||||||
|
|
||||||
# Assert that we have currently no authorizations
|
|
||||||
GET {{ base_url }}/me/authorizations
|
|
||||||
HTTP 200
|
|
||||||
[Asserts]
|
|
||||||
xpath "string(///h1)" == "Your authorizations"
|
|
||||||
xpath "string(///i)" == "You didn't authorized or accessed any applications for now."
|
|
||||||
|
|
||||||
# OAuth2 implicit flow (pre-granted app)
|
|
||||||
GET {{ base_url }}/authorize
|
|
||||||
[QueryStringParams]
|
|
||||||
client_id: 00000001-0000-0000-0000-000000000001
|
|
||||||
response_type: code
|
|
||||||
redirect_uri: http://localhost:9090/callback
|
|
||||||
state: Afk4kf6pbZkms78jM
|
|
||||||
scope: user_read_basic
|
|
||||||
HTTP 302
|
|
||||||
[Captures]
|
|
||||||
authorization_code: header "Location" regex "\\?code=(.*)&"
|
|
||||||
|
|
||||||
# OAuth2 get access token
|
|
||||||
POST {{ base_url }}/api/token
|
|
||||||
[BasicAuth]
|
|
||||||
00000001-0000-0000-0000-000000000001: dummy_client_secret
|
|
||||||
[FormParams]
|
|
||||||
code: {{ authorization_code }}
|
|
||||||
scope: user_read_basic
|
|
||||||
redirect_uri: http://localhost:9090/callback
|
|
||||||
grant_type: authorization_code
|
|
||||||
HTTP 200
|
|
||||||
[Captures]
|
|
||||||
access_token: jsonpath "$.access_token"
|
|
||||||
|
|
||||||
# Asserts that the new authorization is listed
|
|
||||||
GET {{ base_url }}/me/authorizations
|
|
||||||
HTTP 200
|
|
||||||
[Asserts]
|
|
||||||
xpath "string(///h1)" == "Your authorizations"
|
|
||||||
xpath "string(///main/ul/li)" contains "UserReadBasic"
|
|
||||||
|
|
||||||
|
|
@ -1,58 +0,0 @@
|
||||||
signing_key = "tmp/secrets/signing.key"
|
|
||||||
|
|
||||||
[instance]
|
|
||||||
base_uri = "http://localhost:8086"
|
|
||||||
name = "Example org"
|
|
||||||
logo_uri = "https://example.org/logo.png"
|
|
||||||
|
|
||||||
[[applications]]
|
|
||||||
slug = "demo_app"
|
|
||||||
name = "Demo app"
|
|
||||||
description = "A super application where you can do everything you want."
|
|
||||||
client_id = "00000001-0000-0000-0000-000000000001"
|
|
||||||
client_secret = "dummy_client_secret"
|
|
||||||
login_uri = "https://localhost:9876"
|
|
||||||
allowed_redirect_uris = [
|
|
||||||
"http://localhost:9090/callback",
|
|
||||||
"http://localhost:9876/callback"
|
|
||||||
]
|
|
||||||
visibility = "Internal"
|
|
||||||
authorize_flow = "Implicit"
|
|
||||||
|
|
||||||
[[applications]]
|
|
||||||
slug = "wiki"
|
|
||||||
name = "Wiki app"
|
|
||||||
description = "The knowledge base of the exemple org."
|
|
||||||
client_id = "f9de1885-448d-44bb-8c48-7e985486a8c6"
|
|
||||||
client_secret = "49c6c16a-0a8a-4981-a60d-5cb96582cc1a"
|
|
||||||
login_uri = "https://wiki.example.org/login"
|
|
||||||
allowed_redirect_uris = [
|
|
||||||
"https://wiki.example.org/oauth2/callback"
|
|
||||||
]
|
|
||||||
visibility = "Public"
|
|
||||||
authorize_flow = "Implicit"
|
|
||||||
|
|
||||||
[[applications]]
|
|
||||||
slug = "private_app"
|
|
||||||
name = "Demo app"
|
|
||||||
description = "Private app you should never discover"
|
|
||||||
client_id = "c8a08783-2342-4ce3-a3cb-9dc89b6bdf"
|
|
||||||
client_secret = "this_is_the_secret"
|
|
||||||
login_uri = "https://private-app.org"
|
|
||||||
allowed_redirect_uris = [
|
|
||||||
"http://localhost:9091/authorize",
|
|
||||||
]
|
|
||||||
visibility = "Private"
|
|
||||||
authorize_flow = "Implicit"
|
|
||||||
|
|
||||||
[[roles]]
|
|
||||||
slug = "basic"
|
|
||||||
name = "Basic"
|
|
||||||
description = "Basic user"
|
|
||||||
default = true
|
|
||||||
|
|
||||||
[[roles]]
|
|
||||||
slug = "admin"
|
|
||||||
name = "Administrator"
|
|
||||||
description = "Full power on organization instance"
|
|
||||||
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
#!/usr/bin/bash
|
|
||||||
|
|
||||||
password_hash="$(echo -n "root" | argon2 salt_06cGGWYDJCZ -e)"
|
|
||||||
echo $password_hash
|
|
||||||
SQL=$(cat <<EOF
|
|
||||||
INSERT INTO users
|
|
||||||
(id, handle, email, roles, status, password_hash, created_at)
|
|
||||||
VALUES
|
|
||||||
('$(uuid)', 'john.doe', 'john.doe@example.org', '[]', 'Active', '$password_hash', '2024-11-30T00:00:00Z');
|
|
||||||
EOF)
|
|
||||||
echo $SQL | sqlite3 $DB_PATH
|
|
||||||
|
|
@ -1,71 +0,0 @@
|
||||||
# Assert working manifest endpoints
|
|
||||||
GET {{ base_url }}/.well-known/openid-configuration
|
|
||||||
HTTP 200
|
|
||||||
Content-Type: application/json
|
|
||||||
[Asserts]
|
|
||||||
jsonpath "$.issuer" exists
|
|
||||||
jsonpath "$.jwks_uri" exists
|
|
||||||
jsonpath "$.id_token_signing_alg_values_supported[0]" == "RS256"
|
|
||||||
|
|
||||||
# Assert that the server is publishing its public keys
|
|
||||||
GET {{ base_url }}/.well-known/jwks
|
|
||||||
HTTP 200
|
|
||||||
Content-Type: application/json
|
|
||||||
[Asserts]
|
|
||||||
jsonpath "$.keys" exists
|
|
||||||
jsonpath "$.keys[0].n" exists # modulus
|
|
||||||
jsonpath "$.keys[0].e" exists # exponent
|
|
||||||
|
|
||||||
# Login to get user session
|
|
||||||
POST {{ base_url }}/login
|
|
||||||
[FormParams]
|
|
||||||
login: john.doe
|
|
||||||
password: root
|
|
||||||
HTTP 303
|
|
||||||
[Captures]
|
|
||||||
user_jwt: cookie "minauthator_jwt"
|
|
||||||
|
|
||||||
# OAuth2 implicit flow (pre-granted app)
|
|
||||||
GET {{ base_url }}/authorize
|
|
||||||
[QueryStringParams]
|
|
||||||
client_id: 00000001-0000-0000-0000-000000000001
|
|
||||||
response_type: code
|
|
||||||
redirect_uri: http://localhost:9090/callback
|
|
||||||
state: Afk4kf6pbZkms78jM
|
|
||||||
scope: openid profile email
|
|
||||||
HTTP 302
|
|
||||||
[Captures]
|
|
||||||
authorization_code: header "Location" regex "\\?code=(.*)&"
|
|
||||||
|
|
||||||
# Asserts that the OIDC Token exchange is working normally (from the standpoint of the OIDC client)
|
|
||||||
POST {{ base_url }}/api/token
|
|
||||||
[BasicAuth]
|
|
||||||
00000001-0000-0000-0000-000000000001: dummy_client_secret
|
|
||||||
[FormParams]
|
|
||||||
code: {{ authorization_code }}
|
|
||||||
scope: user_read_basic
|
|
||||||
redirect_uri: http://localhost:9090/callback
|
|
||||||
grant_type: authorization_code
|
|
||||||
HTTP 200
|
|
||||||
Content-Type: application/json
|
|
||||||
[Asserts]
|
|
||||||
jsonpath "$.access_token" exists
|
|
||||||
jsonpath "$.id_token" exists
|
|
||||||
jsonpath "$.id_token" matches "eyJ[[:alpha:]0-9].[[:alpha:]0-9].[[:alpha:]0-9]"
|
|
||||||
[Captures]
|
|
||||||
id_token: jsonpath "$.id_token"
|
|
||||||
access_token: jsonpath "$.access_token"
|
|
||||||
|
|
||||||
# Asserts that the OIDC client can fetch the userinfo.
|
|
||||||
GET {{ base_url }}/api/user
|
|
||||||
Authorization: JWT {{ access_token }}
|
|
||||||
HTTP 200
|
|
||||||
Content-Type: application/json
|
|
||||||
[Asserts]
|
|
||||||
jsonpath "$.handle" == "john.doe"
|
|
||||||
jsonpath "$.email" == "john.doe@example.org"
|
|
||||||
|
|
||||||
# TODO: assert id_token JWT claims fields
|
|
||||||
# TODO: contribute to hurl to add JWT extraction and assertion
|
|
||||||
# See. https://github.com/Orange-OpenSource/hurl/issues/2223
|
|
||||||
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
# Asserts that registration is working
|
|
||||||
POST {{ base_url }}/register
|
|
||||||
[FormParams]
|
|
||||||
email: john.doe@example.org
|
|
||||||
handle: john.doe
|
|
||||||
password: mysupersecretpassword
|
|
||||||
HTTP 200
|
|
||||||
[Asserts]
|
|
||||||
xpath "string(///div[@class='alert alert-success'])" contains "account has been created"
|
|
||||||
|
|
||||||
# Asserts that login is possible with new user
|
|
||||||
POST {{ base_url }}/login
|
|
||||||
[FormParams]
|
|
||||||
login: john.doe
|
|
||||||
password: mysupersecretpassword
|
|
||||||
HTTP 303
|
|
||||||
|
|
||||||
|
|
@ -1,10 +0,0 @@
|
||||||
signing_key = "tmp/secrets/signing.key"
|
|
||||||
applications = []
|
|
||||||
|
|
||||||
roles = []
|
|
||||||
|
|
||||||
[instance]
|
|
||||||
base_uri = "http://localhost:8086"
|
|
||||||
name = "Example org"
|
|
||||||
logo_uri = "https://example.org/logo.png"
|
|
||||||
|
|
||||||
|
|
@ -1,5 +1,3 @@
|
||||||
signing_key = "tmp/secrets/signing.key"
|
|
||||||
|
|
||||||
applications = []
|
applications = []
|
||||||
|
|
||||||
roles = []
|
roles = []
|
||||||
|
|
@ -8,3 +6,4 @@ roles = []
|
||||||
base_uri = "http://localhost:8086"
|
base_uri = "http://localhost:8086"
|
||||||
name = "Example org"
|
name = "Example org"
|
||||||
logo_uri = "https://example.org/logo.png"
|
logo_uri = "https://example.org/logo.png"
|
||||||
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue