Browse Source

Doc for HidePasswords

Serj Kalichev 1 year ago
parent
commit
3924922f3a
1 changed files with 39 additions and 3 deletions
  1. 39 3
      docs/klish-plugin-sysrepo.ru.md

+ 39 - 3
docs/klish-plugin-sysrepo.ru.md

@@ -516,9 +516,11 @@ test
 значение, но при этом первый ключ, указывать без имени ключа, только значение.
 Такое поведение будет
 использоваться, если `FirstKeyWithStatement = n`. Это установка используется по
-умолчанию. Если `FirstKeyWithStatement = y`, то первый ключ, также как и все
-последующие нужно указывать с именем ключа. Если `KeysWithStatement = n`, то
-настройка `FirstKeyWithStatement` игнорируется.
+умолчанию. Если `FirstKeyWithStatement = y`, то первый ключ, также, как и все
+последующие, нужно указывать с именем ключа.
+
+> Если `KeysWithStatement = n`, то настройка `FirstKeyWithStatement`
+> игнорируется.
 
 Если `FirstKeyWithStatement = y`:
 
@@ -533,6 +535,40 @@ test
 ```
 
 
+### Настройка `HidePasswords`
+
+Если в конфигурации хранятся пароли или хэши паролей, то такую информацию
+желательно не показывать на экране. Чтобы скрыть значения полей при выводе на
+экран, используется настройка `HidePasswords = y`. Эта настройка действует
+совместно с YANG-расширением `klish:password`, определенным в файле
+`klish.yang`.
+
+YANG-модуль, в котором одно из полей помечено как "пароль".
+
+```
+...
+import klish { prefix "klish"; }
+...
+leaf pass {
+  type string;
+  klish:password;
+}
+...
+```
+
+Затем, если администратор захочет посмотреть содержимое конфигурации, то
+увидит следующее:
+
+```
+# show
+...
+pass <hidden>
+...
+```
+
+Значение поля заменяется на строку `<hidden>`.
+
+
 ### Настройка `Colorize`
 
 Поле может принимать значения `y` и `n`. В случае, если задано `y`, то при