xref: /plugin/extranet/DOKU (revision ef5bb1f3884025c3556b3c46e33332ca386a73a6)

====== Extranet Plugin ======

---- plugin ----
description: Restreint pages, médias et actions pour les visiteurs extranet
author     : Valentin LORTET
email      : contact@valentinlortet.fr
type       : Action, Syntax, Helper
lastupdate : 2026-03-13
compatible : Librarian
depends    : prosemirror
conflicts  :
similar    :
tags       : Access, Extranet, Intranet, Proxy, Security, Helper

downloadurl: https://github.com/Lortet/dokuwiki-plugin-extranet/zipball/master
bugtracker : https://github.com/Lortet/dokuwiki-plugin-extranet/issues
sourcerepo : https://github.com/Lortet/dokuwiki-plugin-extranet/
donationurl:
screenshot_img :
----

���� **Français** | [[plugin:extranet|���� English]] | [[de:plugin:extranet|���� Deutsch]] | [[es:plugin:extranet|���� Español]]

===== Installation =====

Installer le plugin depuis le [[fr:plugin:extension|Gestionnaire d'extensions]] avec l'URL ci-dessus, ou en copiant le dossier dans ''lib/plugins/extranet''.

===== Description =====

Le plugin **extranet** permet :
  * de détecter si une requête vient de l'extranet à partir d'une valeur configurable de ''$_SERVER'' ;
  * de restreindre l'affichage des pages et des médias ;
  * de désactiver certaines actions DokuWiki pour les visiteurs extranet ;
  * d'appliquer des règles globales par filtre ;
  * d'ajouter des exceptions par page avec ''~~NOEXTRANET~~'' et ''~~EXTRANET~~'' ;
  * de s'intégrer à ProseMirror pour conserver ces macros en édition WYSIWYG.

Le plugin est adapté à une logique de segmentation intranet/extranet. Il complète les ACL, mais ne remplace pas un vrai contrôle d'accès.

===== Paramètres =====

^ Nom ^ Description ^ Valeur par défaut ^
| request_match_key | Clé de ''$_SERVER'' utilisée pour déterminer si la requête vient de l'extranet. Peut être ''REMOTE_ADDR'' ou une clé ''HTTP_*''. | '''' |
| extranet_match_list | Liste de valeurs considérées comme extranet, séparées par des virgules. | '''' |
| extranet_match_regex | Regex permettant de détecter une requête extranet à partir de la valeur lue. | '''' |
| default_policy | Politique par défaut : ''allow'', ''block'', ''force_allow'' ou ''force_block''. | ''allow'' |
| filter_list | Liste d'identifiants de pages ou médias ciblés par la politique. Supporte les IDs exacts, namespaces finissant par '':'', et jokers ''*''. | '''' |
| filter_regex | Regex complémentaire pour cibler pages ou médias. | '''' |
| hide_files | Gestion des médias restreints : ''all'', ''except_pageicons'' ou ''none''. | ''none'' |
| disable_actions | Actions DokuWiki désactivées pour les visiteurs extranet. | ''admin,edit,preview,save,revisions,diff,export_raw,export_xhtml,export_xhtmlbody,permalink,register'' |
| restricted_disable_actions | Actions supplémentaires désactivées seulement quand la page courante est restreinte. | '''' |
| preserve_first_title | Conserver le premier titre quand une page est masquée. | ''true'' |
| message_prefix | Préfixe ajouté avant le message de restriction. | '''' |
| message_suffix | Suffixe ajouté après le message de restriction. | '''' |

===== Compatibilité =====

Les anciennes clés de configuration suivantes restent acceptées :
  * ''server_ip_key''
  * ''extranet_ip_list''
  * ''extranet_ip_regex''

Les nouveaux noms sont toutefois à privilégier :
  * ''request_match_key''
  * ''extranet_match_list''
  * ''extranet_match_regex''

===== Utilisation =====

Deux macros sont disponibles :
  * ''~~NOEXTRANET~~'' : bloque la page depuis l'extranet quand la politique l'autorise ;
  * ''~~EXTRANET~~'' : autorise la page depuis l'extranet quand la politique l'autorise.

Comportement selon ''default_policy'' :
  * ''allow'' : tout est autorisé sauf les pages filtrées ou marquées ''~~NOEXTRANET~~'' ;
  * ''block'' : tout est bloqué sauf les pages filtrées ou marquées ''~~EXTRANET~~'' ;
  * ''force_allow'' : seules les règles de filtre s'appliquent, ''~~NOEXTRANET~~'' est ignoré ;
  * ''force_block'' : seules les règles de filtre s'appliquent, ''~~EXTRANET~~'' est ignoré.

===== Exemples =====

Détection par IP directe :
  * ''request_match_key = REMOTE_ADDR''
  * ''extranet_match_regex = /^10\.100\./''

Détection par header proxy :
  * ''request_match_key = HTTP_X_NETWORK_ZONE''
  * ''extranet_match_list = extranet''

Détection par nom d'upstream :
  * ''request_match_key = HTTP_X_UPSTREAM_HOST''
  * ''extranet_match_regex = /^frontend-ext-/''

===== API Helper =====

Charger le helper :
''$extranet = plugin_load('helper', 'extranet');''

==== Méthodes principales ====

^ Méthode ^ Depuis ^ Description ^
| ''getDefaultPolicy()'' | ''2026-03-13'' | Retourne la politique par défaut effective. |
| ''getRequestMatchKey()'' | ''2026-03-13'' | Retourne la clé ''$_SERVER'' utilisée pour la détection. |
| ''getExtranetMatchList()'' | ''2026-03-13'' | Retourne la liste des valeurs considérées comme extranet. |
| ''getExtranetMatchRegex()'' | ''2026-03-13'' | Retourne la regex de détection extranet. |
| ''isExtranetRequest()'' | ''2026-03-13'' | Indique si la requête courante est traitée comme extranet. |
| ''isPageVisibleFromExtranet($id, $content = null)'' | ''2026-03-13'' | Indique si une page est visible depuis l'extranet. |
| ''isMediaVisibleFromExtranet($mediaID)'' | ''2026-03-13'' | Indique si un média est visible depuis l'extranet. |
| ''isPageAllowed($id, $content = null)'' | ''2026-03-13'' | Indique si une page est autorisée dans le contexte courant. |
| ''isMediaAllowed($mediaID)'' | ''2026-03-13'' | Indique si un média est autorisé dans le contexte courant. |
| ''parseRuleList($raw)'' | ''2026-03-13'' | Convertit une configuration de règles en tableau exploitable. |
| ''idMatchesRule($id, $rule)'' | ''2026-03-13'' | Teste un identifiant contre une règle exacte, namespace, joker ou regex. |

===== Fonctionnement =====

La détection extranet repose sur une valeur lue dans ''$_SERVER'' :
  * la valeur brute complète est testée ;
  * si elle contient des virgules, chaque élément séparé est aussi testé.

Cela permet de couvrir :
  * une IP directe ;
  * un header de type ''X-Forwarded-For'' ;
  * un marqueur réseau injecté par proxy ;
  * un nom d'upstream ou de frontal.

Quand une page est restreinte :
  * le cache est séparé entre intranet et extranet ;
  * le contenu wiki est remplacé par un message configurable ;
  * le premier titre peut être conservé si ''preserve_first_title'' est activé.

Quand un média est restreint et que ''hide_files'' n'est pas à ''none'', le plugin renvoie une image dédiée à la place du fichier réel.

===== Notes =====

  * Le plugin ne doit pas être vu comme un remplacement des ACL.
  * La fiabilité dépend du marqueur transmis par l'infrastructure web. Un header non fiable ou forgé rendra la détection non sûre.