bouncer/doc/fr/references/layers/authn/basic.md
William Petit 781bfcab19
All checks were successful
Cadoles/bouncer/pipeline/head This commit looks good
Cadoles/bouncer/pipeline/pr-develop This commit looks good
feat: add authn-basic layer
2024-05-21 12:10:52 +02:00

1.9 KiB

Layer authn-basic

Description

Ce layer permet d'ajouter une authentification de type Basic Auth au service distant.

Type

authn-basic

Schéma des options

Les options disponibles pour le layer sont décrites via un schéma JSON. Elles sont documentées dans le schéma visible ici.

En plus de ces options spécifiques le layer peut également être configuré via les options communes aux layers authn-*.

Objet user et attributs

L'objet user exposé au moteur de règles sera construit de la manière suivante:

  • user.subject sera initialisé avec le nom d'utilisateur identifié ;
  • user.attrs sera composé des attributs associés à l'utilisation (voir les options).

Métriques

Les métriques Prometheus suivantes sont exposées par ce layer.

bouncer_layer_authn_basic_forbidden_total{layer=<layerName>,proxy=<proxyName>}

  • Type: counter

  • Description: Nombre total de tentatives d'accès bloquées

  • Exemple

    # HELP bouncer_layer_authn_basic_forbidden_total Bouncer's authn-basic layer total forbidden accesses
    # TYPE bouncer_layer_authn_basic_forbidden_total counter
    bouncer_layer_authn_basic_forbidden_total{layer="basic",proxy="dummy"} 1
    

bouncer_layer_authn_basic_authorized_total{layer=<layerName>,proxy=<proxyName>}

  • Type: counter

  • Description: Nombre total de tentatives d'accès autorisées

  • Exemple

    # HELP bouncer_layer_authn_basic_authorized_total Bouncer's authn-basic layer total authorized accesses
    # TYPE bouncer_layer_authn_basic_authorized_total counter
    bouncer_layer_authn_basic_authorized_total{layer="basic",proxy="dummy"} 2