klish3.ru.md 30 KB
Klish 3
Обзор
Программа klish предназначенa для организации интерфейса командной строки, в котором оператору доступен только строго определенный набор команд. Это отличает klish от стандартных shell интерпретаторов, где оператор может использовать любые команды, существующие в системе и возможность их выполнения зависит только от прав доступа. Набор доступных в klish команд определяется на этапе конфигурирования и может быть задан, в общем случае, различными способами, основным из которых являются XML файлы конфигурирования. Команды в klish не являются системными командами, а полностью определены в файлах конфигурации, со всеми возможными параметрами, синтаксисом и действиями, которые они выполняют.
Основным применением klish являются встроенные системы, где оператору доступны только определенные, специфические для конкретного устройства, команды, а не произвольный набор команд, как в системах общего назначения. В таких встроенных системах klish может подменить собой shell интерпретатор, недоступный для оператора.
Примером встроенных систем может служить управляемое сетевое оборудование. Исторически в этом сегменте сложилось два основных подхода к организации интерфейса командной строки. Условно их можно назвать подход "Cisco" и подход "Juniper". И Cisco и Juniper имеют два режима работы - командный режим и режим конфигурирования. В командном режиме введенные команды немедленно исполняются, но не влияют на конфигурацию системы. Это команды просмотра состояния, команды управления устройством, но не изменения его конфигурации. В режиме конфигурирования идет настройка оборудования и сервисов. В Cisco команды конфигурирования также исполняются немедленно, меняя конфигурацию системы. В Juniper конфигурацию можно условно представить себе, как текстовый файл, изменения в котором производятся с помощью стандартных команд редактирования. При редактировании изменения не применяются в системе. И только по специальной команде весь накопленный комплекс изменений применяется разом, чем обеспечивается согласованность изменений. При Cisco подходе похожее поведение также можно эмулировать, проектируя команды определенным образом, но для Cisco это менее естественный способ.
Какой из подходов лучше и проще в конкретном случае - определяется задачей. Klish в первую очередь расчитан на подход Cisco, т.е. на немедленно выполняемые команды. Однако проект имеет систему плугинов, что позволяет расширять его возможности. Так плугин klish-plugin-sysrepo, реализованный отдельным проектом, работая на основе хранилища sysrepo, позволяет организовать Juniper подход.
Основные сведения
Основа проекта klish - библиотека libklish. На ее основе построены клиент klish и сервер klishd. Основную работу выполняет сервер klishd. Он загружает конфигурацию команд и ожидает запросов от клиентов. Взаимодействие между клиентами и сервером происходит по UNIX-сокетам с использованием специально разработанного для этой цели протокола KTP (Klish Transfer Protocol). Задача клиента - передача ввода от оператора на сервер и получение от него результата для показа оператору. Клиент не знает, какие команды существуют, как их выполнять. Все это делает серверная сторона. Так как клиент имеет относительно простой код, не трудно реализовать альтернативные программы - клиенты, например графический клиент или клиент для автоматизированного управления. Сейчас написан только текстовый клиент klish. Когда клиент соединяется с сервером, порождается отдельный процесс для обслуживания конкретного клиента. При завершении сессии, процесс также завершается. Таким образом типичное применение klish - это заранее запущенный в системе сервер klishd и клиенты, подключающиеся к нему по мере надобности.
Klish имеет два типа плугинов. Плугины для загрузки конфигурации команд (директория dbs/ в дереве исходных кодов) и плугины, реализующие действия для команд (директория plugins/ в дереве исходных кодов).
Для настройки параметров сервера используется конфигурационный файл
/etc/klish/klishd.conf. Альтернативный конфигурационный файл можно указать при
запуске сервера klishd.
Для настройки параметров клиента используется конфигурационный файл
/etc/klish/klish.conf. Альтернативный конфигурационный файл можно указать при
запуске клиента klish.
Загрузка конфигурации команд
В составе klish существуют следующие плугины dbs (DataBases) для загрузки конфигурации команд (схемы):
- expat - Использует библиотеку expat для загрузки конфигурации из XML.
- libxml2 - Использует библиотеку libxml2 для загрузки конфигурации из XML.
- roxml - Использует библиотеку roxml для загрузки конфигурации из XML.
- ischeme - Использует встроенную в C-код конфигурацию (Internal Scheme).
Существует внутреннее представление схемы, совпадающее с ischeme. Остальные плугины переводят внешние представление в ischeme, а klish обрабатывает ischeme внутренними механизмами.
Установленные плугины dbs находятся в /usr/lib/klish/dbs (если конфигурировать
сборку с --prefix=/usr). Их имена kdb-<имя>.so, например
/usr/lib/klish/dbs/kdb-libxml2.so.
Плугины исполняемых функций
Каждая команда klish выполняет какое-либо действие или несколько действий сразу. Эти действия надо как-то описывать. Если смотреть внутрь реализации, то klish может запускать только исполняемый откомпилированный код из плугина. Плугины содержат так называемые символы (symbol, sym), которые, по-сути, представляют собой функции с единым зафиксированным API. На эти символы могут ссылаться команды klish. В свою очередь символ может выполнять сложный код, например запускать интерпретатор shell со скриптом, определяемым при описании команды klish в конфигурационном файле. Или же другой символ может исполнять Lua скрипт.
Klish умеет получать символы только из плугинов. Стандартные символы реализованы в плугинах включенных в состав проекта klish. В состав klish входят следующие плугины:
- klish - Базовый плугин. Навигация, типы данных (для параметров), вспомогательные функции.
- lua - Исполнение скриптов Lua. Механизм встроен в плугин и не использует внешнюю программу для интерпретации.
- script - Исполнение скриптов. Учитывает шебанг (shebang) для определения какой интерпретатор использовать. Таким образом могут выполняться не только shell скрипты, но и скрипты на других интерпретируемых языках. По умолчанию используется интерпретатор shell.
Пользователи могут писать свои плугины и использовать собственные символы в
командах klish. Установленные плугины находятся в /usr/lib/klish/plugins
(если конфигурировать сборку с --prefix=/usr). Их имена kplugin-<имя>.so,
например /usr/lib/klish/plugins/kplugin-script.so.
Символы бывают "синхронные" и "асинхронные". Синхронные символы исполняются в адресном пространстве klishd, для асинхронных порождается отдельный процесс.
Структура XML конфигурации
Основным способом описания klish команд на сегодняшний день являются XML файлы. В данном разделе все примеры будут основаны на XML элементах.
Области видимости
Команды организованы в "области видимости", называемые VIEW. Т.е. каждая команда принадлежит какому-либо VIEW и в нем определена. При работе в klish всегда существует "текущий путь". По умолчанию, при запуске klish текущим путем назначается VIEW с именем "main". Текущий путь определяет какие команды в данный момент видны оператору. Текущий путь можно менять командами навигации. Например перейти в "соседний" VIEW, тогда текущим путем станет этот соседний VIEW, вытеснив старый. Другая возможность - "уйти вглубь", т.е. зайти во вложенный VIEW. Тогда текущий путь станет двух-уровневым, подобно тому, как можно зайти во вложенную директорию в файловой системе. Когда текущий путь имеет более одного уровня, оператору доступны команды самого "глубокого" VIEW, а также команды всех вышележащих уровней. С помощью команд навигации можно выходить из вложенных уровней. При смене текущего пути используемая команда навигации определяет будет ли VIEW текущего пути вытеснен на том же уровне вложенности другим VIEW, либо новый VIEW станет вложенным и в текущем пути появится еще один уровень. То, как VIEW определены в XML файлах не влияет на то, может ли VIEW быть вложенным.
При определении VIEW в XML файлах, одни VIEW могут быть вложены в другие VIEW. Не надо путать эту вложенность с вложенностью при формировании текущего пути. VIEW, определенный внутри другого VIEW добавляет свои команды к командам родительского VIEW, но при этом может адресоваться и отдельно от родительского. Кроме этого существуют ссылки на VIEW. Объявив такую ссылку внутри VIEW, мы добавляем команды того VIEW, на который указывает ссылка, к командам текущего VIEW. Можно определить VIEW со "стандартными" командами и включать ссылку на этот VIEW в другие VIEW, где требуются эти команды, не переопределяя их заново.
В XML файлах конфигурации для объявления VIEW используется тег VIEW.
Команды и параметры
Команды (тег COMMAND) могут иметь параметры (тег PARAM). Команда определяется
внутри какого-либо VIEW и пренадлежит ему. Параметры определяются внутри команды
и, в свою очередь, принадлежат ей. Команда может состоять только из одного слова,
в отличие от команд в klish предыдущих версий. Если нужно определить многословную
команду, то создаются вложенные команды. Т.е. внутри команды, идентифицируемой по
первому слову многословной команды, создается команда, идентифицируемая по
второму слову многословной команды и т.д.
Строго говоря, команда отличается от параметра только тем, что ее значением может быть только заранее определенное слово, в то время, как значением параметра может быть что угодно. Только тип параметра определяет его возможные значения. Таким образом команду можно рассматривать как параметр с типом, который говорит о том, что допустимым значением является само имя параметра. Внутренняя реализация команд именно такая.
В общем случае параметр может определяться непосредственно во VIEW, а не внутри команды, но это скорее нетипичный случай.
Как и VIEW, команды и параметры могут быть ссылками. В этом случае ссылку можно рассматривать просто как подстановку того объекта, на который указывает ссылка.
Параметры могут быть обязательными, опциональными, либо являться обязательным выбором среди нескольких параметров - кандидатов. Таким образом при вводе команды оператором некорые параметры могут быть указаны, а некоторые нет. При разборе командной строки составляется последовательность выбранных параметров.
Тип параметра
Тип параметра определяет допустимые значения этого параметра. Обычно типы
определяются отдельно с помощью тега PTYPE, а параметр ссылается на определенный
тип по его имени. Также тип может быть определен прямо внутри параметра, но это
не типичный случай, т.к. стандартными типами удается покрыть большую часть
потребностей.
Тип PTYPE, как и команда, выполняет определенное действие, заданное тегом
ACTION. Действие, заданное для типа, проверяет введенное оператором значение
параметра и возвращает результат - успех или ошибка.
Действие
Каждая команда должна определять действие, выполняемое при вводе этой команды
оператором. Действие может быть одно, либо несколько действий для одной команды.
Действие объявляется тегом ACTION внутри команды. В ACTION указывается ссылка
на символ (функцию) из плугина функций, которая будет исполнена в данном случае.
Все данные внутри тега ACTION доступны символу. Символ по своему усмотрению может
использовать эту информацию. В качестве данных, например, может быть задан
скрипт, который будет выполнен символом.
Результатом выполнения действия является "код возврата". Он определяет успешность или неуспешность выполнения команды вцелом. Если для одной команды определено более одного действия, то вычисление кода возврата становится более сложной задачей. Каждое действие имеет флаг, определяющий влияет ли код возврата текущего действия на общий код возврата. Так же действия имеют настройки, определяющие будет ли выполняться действие при условии, что предыдущее действие завершилось с ошибкой. Если последовательно выполняются несколько действий, имеющих флаг влияния на общий код возврата, то общим кодом возврата будет код возврата последнего такого действия.
Фильтры
Фильтры представляют собой команды, которые обрабатывают вывод других команд.
Фильтр может быть указан в командной строке после основной команды и знака |.
Фильтр не может быть самостоятельной командой и использоваться без основной
команды. Примером типичного фильтра может служить аналог UNIX утилиты grep.
Фильтры могут использоваться один за другим, с разделителем |, как это
делается в shell.
Если команда не является фильтром, то она не может использоваться после символа
|.
Фильтр задается в файлах конфигурации с помощью тега FILTER.
Контейнеры параметров
Контейнеры SWITCH и SEQ используются для аггрегации вложенных в них параметров и определяют правила по которым происходит разбор командной строки относительно этих параметров.
По умолчанию считается, что если внутри команды определено последовательно несколько параметров, то все эти параметры так же последовательно должны присутствовать в командной строке. Однако иногда возникает необходимость, чтобы оператор ввел лишь один параметр по выбору из набора возможных параметров. В таком случае может использоваться контейнер SWITCH. Если при разборе командной строки внутри команды встречается контейнер SWITCH, то для соответствия следующему введенному оператором слова должет быть выбран только один параметр из параметров, вложенных в SWITCH. Т.е. с помощью контейнера SWITCH происходит ветвление разбора.
Контейнер SEQ определяет последовательность параметров. Все они должны быть последовательно сопоставлены с командной строкой. Хотя, как было отмечено ранее, вложенные в команду параметры и так разбираются последовательно, однако контейнер может быть полезен в более сложных конструкциях. Например контейнер SEQ сам может быть элементом контейнера SWITCH.
Приглашения командной строки
Для формирования приглашения командной строки, которую видит оператор,
используется конструкция PROMPT. Тег PROMPT должен быть вложен внутрь VIEW.
Разные VIEW могут иметь разные приглашения. Т.е. в зависимости от текущего
пути, оператор видит разное приглашение. Приглашение может быть динамическим
и генерироваться действиями ACTION, заданными внутри PROMPT.
Автодополнение и подсказки
Для удобства работы оператора для команд и параметров могут быть реализованы
подсказки и автодополнение. Подсказки (help), поясняющие предназначение и
формат возможных параметров, отображаются в клиенте klish по нажатию клавиши
?. Список возможных дополнений печатается при нажатии оператором клавиши Tab.
Для задания подсказок и списка возможных дополнений в конфигурации используются
теги HELP и COMPL. Эти теги должны быть вложенными относительно
соответствующих команд и параметров. Для простоты подсказки для параметра или
команды могут быть заданы аттрибутом основного тега, если подказка является
статическим текстом и ее не нужно генерировать. Если подсказка динамическая, то
ее содержимое генерируется действиями ACTION, вложенными внутрь HELP. Для
дополнений COMPL действия ACTION генерируют список возможных значений
параметра, разделенных переводом строки.
Условный элемент
Команды и параметры могут быть скрыты от оператора на основании динамических
условий. Условие задается с помощью тега COND, вложенного внутрь
соответствующей команды или параметра. Внутри COND находятся одно или несколько
действий ACTION. Если код возврата ACTION 0, т.е. успех, то параметр доступен
оператору. Если ACTION вернули ошибку, то элемент будет скрыт.
Плугин
Процесс klishd загружает не все существующие плугины функций подряд, а только
те, которые указаны в конфигурации с помощью тега PLUGIN. Данные внутри тега
могут интерпретироваться функцией инициализации плугина по своему усмотрению,
в частности, как конфигурация для плугина.
Горячие клавиши
Для удобства оператора в конфигурации команд klish могут быть заданы "горячие
клавиши". Тег для задания горячих клавиш - HOTKEY. Список горячих клавиш
передается сервером klishd клиенту. Клиент на свое усмотрение использует эту
информацию или не использует. Например для клиента автоматизированного управления
информация о горячих клавишах не имеет смысла.
При определении горячей клавиши указывается текстовая команда, которая должна быть выполнена при нажатии горячей клавиши оператором. Это может быть быстрый показ текущей конфигурации устройства, выход из текущего VIEW, либо любая другая команда. Клиент klish "ловит" нажатие горячих клавиш и передает на сервер команду, соответствующую нажатой горячей клавише.
Теги
KLISH
Любой XML файл с конфигурацией klish должен начинаться открывающим тегом KLISH
и заканчиваться закрывающим тегом KLISH.
<?xml version="1.0" encoding="UTF-8"?>
<KLISH
xmlns="https://klish.libcode.org/klish3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://src.libcode.org/pkun/klish/src/master/klish.xsd">
<!-- Тут любая конфигурация для klish -->
</KLISH>
Заголовок вводит свое пространство имен XML по умолчанию "https://klish.libcode.org/klish3". Заголовок стардартный и чаще всего нет смысла его менять.