51 lines
1.9 KiB
Markdown
51 lines
1.9 KiB
Markdown
# Layer `authn-basic`
|
|
|
|
## Description
|
|
|
|
Ce layer permet d'ajouter une authentification de type [`Basic Auth`](https://en.wikipedia.org/wiki/Basic_access_authentication) au service distant.
|
|
|
|
## Type
|
|
|
|
`authn-basic`
|
|
|
|
## Schéma des options
|
|
|
|
Les options disponibles pour le layer sont décrites via un [schéma JSON](https://json-schema.org/specification). Elles sont documentées dans le [schéma visible ici](../../../../../internal/proxy/director/layer/authn/basic/layer-options.json).
|
|
|
|
En plus de ces options spécifiques le layer peut également être configuré via [les options communes aux layers `authn-*`](../../../../../internal/proxy/director/layer/authn/layer-options.json).
|
|
|
|
## 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](../../metrics.md) 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
|
|
```
|