Руководство по использованию команд secPaver

[TOC]

Предисловие

В этом документе описывается, как использовать команды в пакете secPaver.

1 Введение

pav — это клиентский процесс secPaver, который предоставляет интерфейс командной строки для использования secPaver пользователями.

pavd — это серверный процесс secPaver, управляющий ресурсами данных, обрабатывающий запросы клиентов и возвращающий результаты обработки.

2 Формат команд

Формат команды secPaver:

pav [options] OBJECT SUMCOMMAND [SUBCOMMAND_ARGUMENTS]
pavd [options]

где параметры указывают глобальные параметры, OBJECT указывает на управляемый объект команды, SUMCOMMAND указывает подкоманду, поддерживаемую управляемым объектом, а SUBCOMMAND_ARGUMENTS указывает аргументы подкоманды.

• Глобальные параметры pav могут использоваться для управления подкомандами, но глобальные параметры должны быть размещены перед подкомандами управления. Например:

pav -s /var/run/secpaver/pavd.sock project list

• [PARM] указывает необязательный параметр, а <PARM> указывает обязательный параметр.

3 Команда pav

3.1 Глобальные параметры

Глобальные параметры pav включают справочную информацию, запрос версии и конфигурации подключения.

3.1.1 --help, -h

Описание:

Выводит справочную информацию.

Формат:

pav --help

3.1.2 --version, -v

Описание:

Печатает версию pav.

Формат:

pav --version

3.1.3 --socket, -s

Описание:

Указывает файл сокета Unix, используемый для соединения grpc. Значение по умолчанию — /var/run/secpaver/pavd.sock.

Формат:

pav --socket <PATH>

3.2 Команды управления движком

Описание:

Управляет подключаемым модулем генератора политик.

Формат:

pav engine SUBCOMMAND

Поддерживаемые подкоманды:

3.2.1 list

Описание:

Перечисляет все загруженные подключаемые модули генератора политик.

Формат:

pav engine list

Параметры:

Нет.

Пример:

# pav engine list

Name        Desc                               
selinux     selinux policy generate engine     

3.2.2 info

Описание:

Перечисляет детали одного загруженного подключаемого модуля генератора политик.

Формат:

pav engine info <ENGINE>

Параметры:

Пример:

# pav engine info selinux

Attribute     Value                             
Name          selinux                           
Desc          selinux policy generate engine    

3.3 Команды управления проектом

Описание:

Управление проектами, хранящимися на сервере secPaver.

Формат:

pav project SUBCOMMAND

Поддерживаемые подкоманды:

3.3.1 create

Описание:

Создаёт шаблон проекта.

Формат:

pav project create <NAME> <PATH>

Параметры:

Пример:

# pav project create demo /root
create demo template project at /root/demo
# tree /root/demo/
/root/demo/
├── resources.json
├── selinux.json
├── specs
│   └── module_demo.json
└── pav.proj

1 directory, 4 files

3.3.2 list

Описание:

Перечисляет все проекты, хранящиеся на сервере secPaver.

Формат:

pav project list

Параметры:

Нет.

Пример:

# pav project list

Name       Version  
demo       1.0

3.3.3 info

Описание:

Перечисляет подробности указанного проекта, хранящегося на сервере secPaver.

Формат:

pav project info <PROJECT>

Параметры:

Пример:

# pav project info demo

Attribute        Value                     
name             demo                      
resource file    resources.json            
spec files       specs/module_demo.json

3.3.4 import

Описание:

Импортирует файл проекта (формат zip) на сервер secPaver.

Формат:

pav project import [-f] <FILE>

Параметры:

Пример:

# pav project import demo.zip 
[info]: Finish importing demo project

3.3.5 Экспорт

Описание:

Экспортировать заданный проект в виде ZIP-файла со стороны сервера.

Формат:

pav project export [-f] <ПРОЕКТ> <ПУТЬ>

Параметры:

Пример:

# pav project export demo .
Finish exporting: export_demo.zip

3.3.6 Удаление

Описание:

Удалить указанный проект, хранящийся на сервере secPaver.

Формат:

pav project delete <ПРОЕКТ>

Параметры:

Пример:

# pav project delete demo
[info]: Finish deleting demo project

3.3.7 Сборка

Описание:

Скомпилировать проект и сгенерировать политику на основе указанного движка. Проект может быть одним на сервере secPaver или указанным по локальному пути.

Формат:

pav project build --engine <ДВИЖОК> <-d ПУТЬ | -r ПРОЕКТ>

Параметры:

Пример:

# pav project build -d ./demo --engine selinux
[info]: Finish building demo project

# pav project build -r demo --engine selinux
[info]: Finish building demo project

3.4 Управление политиками команд

Описание:

Управление созданными политиками.

Формат:

pav policy SUBCOMMAND

Поддерживаемые подкоманды:

3.4.1 Список

Описание:

Перечислить все созданные политики.

Формат:

pav policy list

Параметры: Нет

Пример:

# pav policy list

Name                       Status     
demo_selinux               disable

3.4.2 Установка

Описание:

Установить созданную политику.

Формат:

pav policy install <ПОЛИТИКА>

Параметры:

Пример:

# pav policy install demo_selinux
[info]: install SELinux policy module
[info]: start to restore file context
[info]: Finish installing policy

3.4.3 Удаление

Описание:

Отменить созданную политику.

Формат:

pav policy uninstall <ПОЛИТИКА>

Параметры:

Пример:

# pav policy uninstall demo_selinux
[info]: uninstall SELinux policy module
[info]: restore file context
[info]: Finish uninstalling policy uninstalling

3.4.4 Экспорт

Описание:

Экспорт созданной политики в ZIP-файл.

Формат:

pav policy export [-f] <ПОЛИТИКА> <ПУТЬ>

Параметры:

Пример:

# pav policy export demo_selinux .
Finish exporting: export_demo_selinux.zip

3.4.5 Удаление

Описание:

Удаление политики со стороны сервера.

Формат:

pav policy delete <ПОЛИТИКА>

Параметры:

Пример:

# pav policy delete demo_selinux
[info]: Finish deleting policy

4 Команда pavd

4.1 Глобальные параметры

Глобальные параметры pavd включают справочную информацию, запрос версии и основные конфигурации.

4.1.1 --help, -h

Описание:

Вывести справочную информацию.

Формат:

pavd --help

4.1.2 --version, -v

Описание:

Печать версии pavd.

Формат:

pavd --version

4.1.3 --config, -c

Описание:

Указанный файл конфигурации, значение по умолчанию — /etc/secpaver/pavd/config.json.

Формат:

pavd --config <ФАЙЛ>

4.1.4 --socket, -s

Описание:

Путь к файлу сокета grpc, значение по умолчанию — /var/run/secpaver/pavd.sock.