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

Введение

Данный документ описывает использование клиентского приложения secPaver pav и серверного приложения pavd в командной строке.

1. Обзор

pav — это клиентское приложение secPaver, которое отвечает за взаимодействие с сервером pavd через командную строку.

pavd — это серверное приложение secPaver. Оно отвечает за управление ресурсами secPaver на сервере и обработку запросов от клиента pav, а также за предоставление результатов обработки.

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

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

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

Здесь options — глобальные параметры, OBJECT — объект, на который действует команда, SUMCOMMAND — основная команда для объекта, SUBCOMMAND_ARGUMENTS — аргументы подкоманды.

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

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

В формате команды квадратные скобки [] обозначают необязательные параметры, угловые скобки <> обозначают обязательные параметры.

3. Команды pav

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

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

3.1.1. --help, -h

Описание функции:

Выводит информацию о помощи для команды pav.

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

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. Управление подкомандами engine

Описание команды:

Управляет плагинами генерации политик на сервере.

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

pav engine SUBCOMMAND [SUBCOMMAND_ARGUMENTS]

Поддерживаются следующие подкоманды:

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>

Параметры команды:

Параметр	Описание
ENGINE	Имя плагина генерации политики

Пример использования:

# pav engine info selinux

Attribute     Value                             
Name          selinux                           
Desc          selinux policy generate engine

3.3. Управление подкомандами project

Описание команды:

Управление файлами проектов на сервере.

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

pav project SUBCOMMAND [SUBCOMMAND_ARGUMENTS]

Поддерживаемые подкоманды включают:

3.3.1. create

Описание команды:

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

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

pav project create <NAME> <PATH>

Параметры команды:

Параметр	Описание
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

Описание команды:

Отображает список проектов, управляемых сервером.

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

pav project list

Параметры команды:

Нет.

Пример использования:

# pav project list

Name       Version  
demo       1.0

3.3.3. info

Описание команды:

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

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

pav project info <PROJECT>

Параметры команды:

Параметр	Описание
PROJECT	Название управляемого проекта

Пример использования:

# pav project info demo

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

3.3.4. import

Описание команды:

Импортирует файлы проекта, которые должны быть в формате zip.

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

pav project import [-f] <FILE>

Параметры команды:

Параметр	Описание
--force, -f	Разрешает перезапись существующего проекта при наличии
FILE	Файл проекта в формате zip

Пример использования:

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

3.3.5. export

Описание команды:

Экспортирует указанный проект в виде файла zip.

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

pav project export [-f] <PROJECT> <PATH>

Параметры команды:

Параметр	Описание
--force, -f	Позволяет перезаписать существующий файл при наличии
PROJECT	Название экспортируемого проекта
PATH	Путь экспорта, должен быть допустимым каталогом

Пример использования:

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

3.3.6. delete

Описание команды:

Удаляет указанный проект с сервера.

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

pav project delete <PROJECT>

Параметры команды:

Параметр	Описание
PROJECT	Название удаляемого проекта

Пример использования:

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

3.3.7. build

Описание команды:

Компилирует указанный проект, генерирует и экспортирует файл политики для указанного механизма безопасности. Проект может быть локальным или управляемым сервером.

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

pav project build --engine <ENGINE> <-d PATH | -r PROJECT>

Параметры команды:

Параметр	Описание
--engine ENGINE	Указывает механизм безопасности для генерации файла политики
-d PATH	Каталог локального проекта
-r PROJECT	Управляемый серверный проект

Пример использования:

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

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

**Поддерживаемые SUBCOMMAND:**

#### 3.4.1 list

**Описание команды:**

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

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

pav policy list


**Параметры команды:**

Отсутствуют.

**Пример использования:**

pav policy list

Name Status
demo_selinux disable


#### 3.4.2 install

**Описание команды:**

Устанавливает и загружает созданную политику.

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

pav policy install


**Параметры команды:**
| Параметр | Описание |
| :---: | :---: |
| POLICY | Указанное имя политики службы |

**Пример использования:**

pav policy install demo_selinux

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


#### 3.4.3 uninstall

**Описание команды:**

Удаляет созданную политику из системы.

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

pav policy uninstall


**Параметры команды:**
| Параметр | Описание |
| :---: | :---: |
| POLICY | Указанное имя политики службы |

**Пример использования:**

pav policy uninstall demo_selinux

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


#### 3.4.4 export

**Описание команды:**

Экспортирует файл политики, созданной на стороне службы, в формате zip.

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

pav policy export [-f]


**Параметры команды:**
| Параметр | Описание |
| :---: | :---: |
| --force, -f | Разрешает перезапись существующего файла при экспорте, если путь экспорта уже существует |
| POLICY | Указанное имя политики службы |
| PATH | Путь экспорта, должен быть действительным каталогом |

**Пример использования:**

pav policy export demo_selinux .

Finish exporting: export_demo_selinux.zip


#### 3.4.5 delete

**Описание команды:**

Удаляет указанную политику на стороне службы.

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

pav policy delete


**Параметры команды:**
| Параметр | Описание |
| :---: | :---: |
| POLICY | Указанное имя политики службы |

**Пример использования:**

pav policy delete demo_selinux

[info]: Finish deleting policy


## 4 pavd программа команды

### 4.1 Глобальные команды

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

#### 4.1.1 --help, -h

**Описание функции:**

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

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

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.

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

pavd --socket


#### 4.1.5 --log-level, -l

**Команда описания:**

Задаёт уровень журнала. Уровень журнала может быть debug, info, warn, error, fatal, panic. Уровень журнала можно указать в файле конфигурации; если он не указан в файле конфигурации, используется значение по умолчанию info.

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

pavd --log-level


### 4.2 Команды systemd

**Команда описания:**

После установки secPaver можно управлять процессом службы pavd с помощью команд systemd.

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

Запуск службы pavd:

systemctl start pavd


Остановка службы pavd:

systemctl stop pavd


Проверка состояния службы pavd:

systemctl status pavd

OSCHINA-MIRROR/openeuler-secpaver

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

Введение

1. Обзор

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

3. Команды pav

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

3.1.1. --help, -h

3.1.2. --version, -v

3.1.3. --socket, -s

3.2. Управление подкомандами engine

3.2.1. list

3.2.2. info

3.3. Управление подкомандами project

3.3.1. create

3.3.2. list

3.3.3. info

3.3.4. import

3.3.5. export

3.3.6. delete

3.3.7. build

pav policy list

pav policy install demo_selinux

pav policy uninstall demo_selinux

pav policy export demo_selinux .

pav policy delete demo_selinux

Опубликовать ( 0 )

Введение

Обновления

Участники

Недавние действия

OSCHINA-MIRROR/openeuler-secpaver .gitee-modal { min-width: 500px !important; } .gitee-modal .close { right: 0.6rem !important; }

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

Введение

1. Обзор

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

3. Команды pav

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

3.1.1. --help, -h

3.1.2. --version, -v

3.1.3. --socket, -s

3.2. Управление подкомандами engine

3.2.1. list

3.2.2. info

3.3. Управление подкомандами project

3.3.1. create

3.3.2. list

3.3.3. info

3.3.4. import

3.3.5. export

3.3.6. delete

3.3.7. build

pav policy list

pav policy install demo_selinux

pav policy uninstall demo_selinux

pav policy export demo_selinux .

pav policy delete demo_selinux

Опубликовать ( 0 )

Введение

Обновления

Участники

Недавние действия

OSCHINA-MIRROR/openeuler-secpaver