Skip to content
Commits on Source (4)
Hide whitespace changes
Inline Side-by-side
.gitlab-ci.yml
View file @ 3fc3a6c6
......@@ -39,7 +39,7 @@ docker:
rules:
- if: $CI_COMMIT_REF_PROTECTED == "true"
release:dry-run:
release-prepare:
stage: publish
image: node:alpine
before_script:
......@@ -55,7 +55,8 @@ release:dry-run:
- git config --global user.email "${GITLAB_USER_EMAIL}"
- npm ci
script:
- GITLAB_TOKEN=${RELEASE_IT_TOKEN} npx release-it --ci --no-npm --gitlab.release --dry-run
- git pull
- GITLAB_TOKEN=${RELEASE_IT_TOKEN} npx release-it --ci --no-npm --no-git.requireUpstream
- >-
curl
--header "PRIVATE-TOKEN: ${RELEASE_IT_TOKEN}"
......@@ -66,23 +67,12 @@ release:dry-run:
- if: $CI_PIPELINE_SOURCE == "merge_request_event" &&
$CI_MERGE_REQUEST_LABELS =~ /RELEASE/ &&
$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
release:prepare:
stage: publish
extends:
- release:dry-run
script:
- GITLAB_TOKEN=${RELEASE_IT_TOKEN} npx release-it --ci --no-npm
rules:
- if: $CI_PIPELINE_SOURCE == "merge_request_event" &&
$CI_MERGE_REQUEST_LABELS =~ /RELEASE/ &&
$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
when: manual
release:
stage: publish
extends:
- release:dry-run
- release-prepare
script:
- GITLAB_TOKEN=${RELEASE_IT_TOKEN} npx release-it --ci --no-git --no-increment --no-npm --gitlab.release
rules:
......
.release-it.toml
View file @ 3fc3a6c6
[git]
requireCommits = true
tag = false
commitMessage = "chore(release): ${version}"
[plugins]
[plugins."@release-it/conventional-changelog"]
......@@ -7,5 +8,5 @@ infile = "CHANGELOG.md"
[plugins."@release-it/conventional-changelog".preset]
name = "conventionalcommits"
[plugins."@release-it/bumper"]
in = ["package.json", "pyproject.toml"]
out = ["package.json", "pyproject.toml"]
in = ["package.json", "package-lock.json", "pyproject.toml"]
out = ["package.json", "package-lock.json", "pyproject.toml"]
ARCHITECTURE.md 0 → 100644
View file @ 3fc3a6c6
This document describes most important architectural choices and explains
the rationale behind them. It is not a comprehensive architectural guide
for Hiboo (see the code) or Hiboo deployments (see the admins
documentation).
# Why users and profiles
SSO usually handles accounts (or users), and authenticates the user to
every service using their single account (hence *single* sign-on).
SSO requires careful planning and is best suited for enterprise use,
where every employee gets their account, where naming follows convention,
and every application is built on top of SSO by design.
Independant hosting services usually handle many services already before
they even think about deploying SSO. Their users might need a single, two
or all of their services at once. Sometimes two different users have
accounts on various services using identical usernames before SSO is
set up.
Also, users often require multiple accounts on a single service, e.g.
to escape harassment. They want these accounts separate, with no obvious
relationship for the public. Sometimes users want to share a single
account but not share credentials.
For these reasons, Hiboo has separate concepts for a user (a person
that can authenticate to Hiboo, receive notifications...) and a profile
(that person's identity on one service at one point). A profile is
owned by a single user (but could be shared) and is user on a single
service.
# Username claims
When migrating to SSO, an organization most often already has users,
and not always a definite way of identifying them and grant proper
access for everyone to their own accounts on every service.
However, users already have a way of authenticating against pre-existing
services. To prevent people from malicious access by just stealing a
username when switching to SSO, pre-existing usernames should be
reserved upon migrating to SSO, then corresponding profiles should be
associated with users.
Claims are a way to autonomize users an migrate easily to SSO. We store
the old password hash associated with the unclaimed profile, and check
once for the old account password before we associated the profile to the
user requesting it. Claims also support alternate names, so users may
claim them using the profile name, their e-mail address, or whichever
identifier they used to type in before SSO.
# Application and service
Services materialize the OIDC client or SAML service provider configuration:
they hold profiles and SSO configuration for the application.
On top of generic services, Hiboo provides specialized configurations and
advanced techno-specific features based on APIs for supported software.
Each supported project is mapped to an application, and each service
points to applications to benefit from its features.
Applications are Python modules and custom templates for the service.
Currently they are bundled with Hiboo itself, they should be maintained
in separate projects in the future.
# Every service is a provider
Some SSO systems, especially SAML and OIDC implementations, act as a single
issuer, or have separate large "realms", each one hosting many users and
services and acting as a single provider.
Each Hiboo service acts as a separate provider. Each OIDC service is a
separate issuer (OpenID Provider) and each SAML service is a separate IdP.
This makes sense because profiles are bound to services, so two separate
services might authenticate separate profiles with conflicting attributes
(e.g. the preferred username).
# Not divulging personal data
Hiboo is designed to not divulge any non-required personal data. Often
SSO is a way to protect user authenticating data like their password.
Hiboo takes this one step further and avoids sharing any data except for
a user id and username to the service.
Currently Hiboo anonymizes emails by mapping profile ids to email
addresses and providing an API for mail relays to map notifications.
At some point it could do the same for any kind of notification.
# Flask blueprints
Every Hiboo concept has its own Flask blueprint, according to Flask design
patterns. Blueprints encapsulate views and templates.
Models are managed in the `models` module however, outside blueprints, so
they can easily be related to each other.
A special `sso` blueprint handles the actual service authentication, using
most base concepts (services, users, profiles) to implement OIDC and SAML
logics.
CHANGELOG.md
View file @ 3fc3a6c6
## [0.3.0](https://forge.tedomum.net/acides/hiboo/compare/0.2.0...0.3.0) - [`Strix aluco`](https://fr.wikipedia.org/wiki/Chouette_hulotte) (2025-05-23)
![strix aluco](https://img.tedomum.net/data/strix_aluco-980476.jpeg)
### Features
* **docs**: contribution Closes [#126](https://forge.tedomum.net/acides/hiboo/-/issues/126) ([074d1827](https://forge.tedomum.net/acides/hiboo/-/commit/074d1827770a0963c9c7f151da68e712d3a51f25))
* **docs**: architecture Closes [#121](https://forge.tedomum.net/acides/hiboo/-/issues/121) ([c8a491fb](https://forge.tedomum.net/acides/hiboo/-/commit/c8a491fbfd5cbb8fcc885279a426024d71126fa7))
* add a favicon ([d24eba3](https://forge.tedomum.net/acides/hiboo/commit/d24eba3adefc8b1fdd751facf0c87b0e8e8aa080))
* **docs:** Online documentation, Closes [#189](https://forge.tedomum.net/acides/hiboo/issues/189) ([2e1d62d](https://forge.tedomum.net/acides/hiboo/commit/2e1d62dd5b4664bda23624c40fe12016bff4754c))
### Bug Fixes
* fix release workflow Closes [#149](https://forge.tedomum.net/acides/hiboo/issues/149) ([83c0bb2](https://forge.tedomum.net/acides/hiboo/commit/83c0bb24ac00ba2b02b07c2b919f44d120ea5d79))
### Other
* **chore**: Python dependencies cleanup Closes [#190](https://forge.tedomum.net/acides/hiboo/issues/190) ([7fc68942](https://forge.tedomum.net/acides/hiboo/-/commit/7fc6894263216f87c1356707dc86707bb2cdbd59))
* Adopt AGPLv3 license Closes [#174](https://forge.tedomum.net/acides/hiboo/-/issues/174) ([918e8f7d](https://forge.tedomum.net/acides/hiboo/-/commit/918e8f7d2b323e950f4908d321fd1d5dc4408121))
## [0.2.0](https://forge.tedomum.net/acides/hiboo/compare/0.1.0...0.2.0) - [`Otus scops`](https://en.wikipedia.org/wiki/Eurasian_scops_owl) (2025-04-27)
![otus scops](https://img.tedomum.net/data/otus_scops-012f90.png)
......
Dockerfile
View file @ 3fc3a6c6
......@@ -25,7 +25,7 @@ FROM python:3.12-slim
RUN apt-get update \
&& apt-get install -y --no-install-recommends \
zlib1g libfreetype6 libjpeg62-turbo libopenjp2-7 libtiff6 liblcms2-2 \
libpq5 libmariadb3 libxmlsec1 xmlsec1 \
libpq5 libmariadb3 xmlsec1 \
&& rm -rf /var/cache/apt \
&& mkdir /app
WORKDIR /app
......
LICENSE
View file @ 3fc3a6c6
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
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
......@@ -7,17 +7,15 @@
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
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,
the GNU General Public License is intended to guarantee your freedom to
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. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
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
......@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
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.
......@@ -72,7 +60,7 @@ modification follow.
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"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.
......@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
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 Affero General Public License into a single
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 special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
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 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
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 General
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 General Public License, you may choose any version ever published
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 General Public License can be used, that proxy's
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.
......@@ -631,44 +629,33 @@ 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.
Hiboo
Copyright (C) 2022 ACIDES / Hiboo
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
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 General Public License for more details.
GNU Affero General Public License for more details.
You should have received a copy of the GNU General Public License
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 the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) 2022 ACIDES / Hiboo
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
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 GPL, see
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.
README.md
View file @ 3fc3a6c6
......@@ -120,7 +120,7 @@ See full configuration reference in the documentation.
## Contributing
Hiboo is licensed under GPLv3. Contributions are welcome!
Hiboo is licensed under AGPLv3. Contributions are welcome!
Feel free to [open an issue](https://forge.tedomum.net/acides/hiboo/-/issues) and discuss on the [dedicated \[matrix\] channel](https://matrix.to/#/#hiboo:tedomum.net)!
......
assets/app.js
View file @ 3fc3a6c6
import './app.scss';
import './docs.scss';
import './theme.js';
import './favicon.ico'
assets/docs.scss
View file @ 3fc3a6c6
......@@ -46,15 +46,15 @@
}
h6 {
text-transform: uppercase;
font-size: 0.9rem;
font-variant: small-caps;
font-size: 1rem;
code {
font-size: unset;
}
}
h4, h5 {
h4, h5, h6 {
font-weight: 600;
}
......
docs/config/base.yml
View file @ 3fc3a6c6
site_name: Hiboo - Documentation
site_description: Security framework for small-sized hosting services
site_description: Open source security framework for small-sized hosting services
site_author: The Hiboo contributors
copyright: <a href="https://forge.tedomum.net/acides/hiboo/-/graphs/master">Hiboo contributors</a>
repo_url: https://forge.tedomum.net/acides/hiboo/-/tree/dev/docs
theme:
name: null
custom_dir: ../templates
markdown_extensions:
- pymdownx.blocks.admonition
......
docs/config/en.yml
View file @ 3fc3a6c6
......@@ -2,6 +2,9 @@ INHERIT: base.yml
docs_dir: ../content/en
site_dir: ../../hiboo/static/docs/en
theme:
custom_dir: ../templates
nav:
- User Manual: "user/index.md"
- Admin Manual: "admin/index.md"
......
docs/config/fr.yml
View file @ 3fc3a6c6
......@@ -2,11 +2,23 @@ INHERIT: base.yml
docs_dir: ../content/fr
site_dir: ../../hiboo/static/docs/fr
theme:
custom_dir: ../templates
nav:
- Utilisation: "user/index.md"
- Utilisation:
- Compte: "user/account.md"
- Profils: "user/profile.md"
- 🛟 Obtenir de l'aide: "user/help.md"
- Administration:
- Concepts: "admin/concepts.md"
- Déploiement: "admin/install.md"
- Services et applications: "admin/services.md"
- Comptes et profils: "admin/users.md"
- Contribution:
- Problèmes et améliorations: "contrib/bug_and_features.md"
- Développement: "contrib/development.md"
- Documentation: "contrib/docs.md"
- Traduction: "contrib/translate.md"
- 💛 Communauté: "contrib/community.md"
- Changelog: "CHANGELOG.md"
docs/config/pages.yml 0 → 100644
View file @ 3fc3a6c6
INHERIT: base.yml
site_url: https://hiboo.aciges.org
docs_dir: ../content/
theme:
name: material
logo: assets/img/logo_hiboo.png
favicon: assets/img/favicon.ico
language: fr
features:
- navigation.tabs
- navigation.sections
- navigation.path
- navigation.indexes
- navigation.footer
- navigation.expand
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- search.highlight
- toc.follow
- toc.integrate
- content.code.copy
- content.action.edit
- content.action.view
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: deep orange
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: deep orange
toggle:
icon: material/brightness-4
name: Switch to system preference
extra_css:
- assets/pages.css
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.superfences
- pymdownx.blocks.admonition
- attr_list
- toc:
baselevel: 3
plugins:
- search
- mike:
canonical_version: latest
- i18n:
reconfigure_search: true
docs_structure: folder
languages:
- locale: en
name: English
build: true
site_name: Hiboo - Documentation
site_description: Open source security framework for small-sized hosting services
- locale: fr
name: Français
default: true
build: true
site_name: Hiboo - Documentation
site_description: Système de sécurité open source pour les petits hébergeurs
extra:
version:
provider: mike
default: latest
alias: true
nav:
- Utilisation:
- Compte: "user/account.md"
- Profils: "user/profile.md"
- 🛟 Obtenir de l'aide: "user/help.md"
- Administration:
- Concepts: "admin/concepts.md"
- Déploiement: "admin/install.md"
- Services et applications: "admin/services.md"
- Comptes et profils: "admin/users.md"
- Contribution:
- Signaler un problème ou proposer une amélioration: "contrib/bug_and_features.md"
- Participer au développement: "contrib/development.md"
- Proposer des traductions: "contrib/translate.md"
- Documenter: "contrib/docs.md"
- 💛 Communauté: "contrib/community.md"
- Changelog: "fr/CHANGELOG.md"
docs/content/CHANGELOG.md deleted 120000 → 0
View file @ 00c84bfb
../../CHANGELOG.md
\ No newline at end of file
docs/content/assets/pages.css 0 → 100644
View file @ 3fc3a6c6
:root > * {
--md-primary-fg-color: #96897b;
--md-primary-bg-color: #1d233b;
--md-accent-fg-color: #77897D;
--md-typeset-a-color: #ff4646;
}
[data-md-color-scheme="slate"] {
--md-typeset-a-color: #ff6c6c;
--md-default-fg-color: hsla(var(--md-hue), 15%, 90%, 0.92);
--md-default-fg-color--light: hsla(var(--md-hue), 15%, 90%, 0.76);
--md-default-fg-color--lighter: hsla(var(--md-hue), 15%, 90%, 0.52);
--md-default-fg-color--lightest: hsla(var(--md-hue), 15%, 90%, 0.32);
--md-default-bg-color: #2d3142;
}
.md-typeset .admonition, .md-typeset details {
font-size: inherit;
}
docs/content/en/CHANGELOG.md
View file @ 3fc3a6c6
../CHANGELOG.md
\ No newline at end of file
../../../CHANGELOG.md
\ No newline at end of file
docs/content/en/admin/index.md
View file @ 3fc3a6c6
......@@ -3,7 +3,7 @@ title: Admin Manual
---
/// admonition
attrs: {class: 'alert alert-info'}
attrs: {class: 'alert alert-info warning'}
😬 : Sorry, this documentation is not yet available in english. If you want,
you can [translate
......
docs/content/en/index.md
View file @ 3fc3a6c6
---
title:
---
**Welcome to the Hiboo documentation!**
/// admonition
attrs: {class: 'alert alert-info'}
attrs: {class: 'alert alert-info tip'}
**Do not get lost!** Choose the apropriate documentation for your purpose 😉
......