Разрешения и авторизация
Разрешения действий уровня Unit, права объектов по продуктам и авторизация на клиенте и сервере.
Univer разделяет разрешения на два уровня: Действия в целом блоке контента и Разрешения на объекты внутри него. Web SDK использует эти разрешения для управления взаимодействиями и выполнения команд. Server SDK определяет границы авторизации для чтения, совместных представлений и служб расширения.
Разрешения уровня Unit
Подразделение - это один полный экземпляр контента, такой как рабочая книга, документ, презентация, относительная таблица, доска или PDF. Разрешения блока ниже применяются к листам, документам, слайдам, реляционной таблице и холстам. PDF описывается отдельно в своем собственном разделе.
| Разрешение | Что контролирует | Пример |
|---|---|---|
| Редактирование (Edit) | Изменение содержания и структуры. | Зрители читают; редакторы заполняют и перестраивают контент. |
| Копирование (Copy) | Копирование контента внутри редактора. | Разрешить чтение и комментарии, не допуская копирования. |
| Комментарии (Comment) | Запуск комментариев и ответов при установке функций комментариев. | Рецензенты комментируют, в то время как контент остается только для чтения. |
| Печать (Print) | Используя функцию печати продукта. | Разрешить онлайн-чтение, предотвращая печать. |
| Экспорт (Export) | Выгрузка содержимого в поддерживаемый формат файла. | Доставить файл другим или архивировать его. |
Редактирование и комментирование независимы друг от друга. Редактировка, удаление и управление комментариями также следуют политике автора и владельца вашего приложения.
Печать и экспорт также являются разрешениями уровня единицы. Листы, документы, слайды и холсты выставляют оба; Относительная таблица в настоящее время выставляет только экспорт. Каждое разрешение работает с соответствующими плагинами функций.
Копирование контента, дублирование файла, экспорт и загрузка - это четыре отдельные операции. Можно ли открыть файл, зависит от разрешения на чтение вашего приложения.
Например, настройте разрешения уровня Unit для Doc независимо:
import { UnitAction } from '@univerjs/protocol'const document = univerAPI.getActiveDocument()if (!document) throw new Error('Open a document first')const permission = document.getPermission()await permission.setReadOnly()await permission.setPoint(UnitAction.Copy, false)await permission.setPoint(UnitAction.Comment, true)await permission.setPoint(UnitAction.Print, false)await permission.setPoint(UnitAction.Export, false)Для начала зарегистрируйте плагины продукта и комментариев. Для режима плагина также требуется @univerjs/docs/facade. Доступники продукта перечислены ниже. В листах используются собственные номера точек доступа.
Сервер совместной работы Pro проверяет UnitAction.Comment, когда непустая программа изменений содержит только встроенные мутации потоковых комментаций: добавлять, удалять, разрешать, обновлять или обновлять ссылки. Смешанные модули изменений и любые мутации, которые изменяют содержание документа, включая украшения комментариев Docs, по-прежнему требуют UnitAction.Edit. Приложение также должно обеспечивать соблюдение своих собственных политик автора комментариев и владельца. Если вы используете пользовательское ПО службы Collaboration SDK , классифицируйте модули таким же образом в своей политике submitChangeset
Детальные права по продуктам
Sheets
Уровни разрешений - Рабочая тетрадь → рабочий лист → диапазон ячеек. Уровень книги контролирует редактирование, копирование и комментирование всего файла. Точки разрешения рабочего листа ограничивают значения, стили, изменения строк и столбцов, сортировку, фильтрацию, поворотные таблицы и дополнительные объекты. Контроль защиты диапазона, который может редактировать или просматривать выбранную область, и он может назвать сотрудников, которым разрешено.
Например, защитите формулы бюджета и оставьте входы расходов редактируемыми. Используйте getWorkbookPermission(), getWorksheetPermission() и getRangePermission(). Создайте правило защиты рабочего листа или диапазона перед установкой его точек защиты. Когда доступ к чтению ограничен, приложение должно также контролировать данные, которые оно возвращает.
Docs
Ниже уровня документа может быть защищен разделы, параграфы и сущности контента. Сущности включают в себя таблицы, чертежи, пользовательские блоки и диапазоны со стабильными идентификаторами. Заголовки и абзацы нижних колонок рассматриваются через их сегмент.
Например, защитите договорные положения и оставьте пункты, которые необходимо заполнить, в редактируемом виде. Разделы и пункты разоблачают getPermission(); для организаций используйте document.getEntityPermission(). Эффективный результат объединяет документ, любого применимого родителя и собственные правила объекта.
Права документа · Права разделов, абзацев и сущностей
Slides
Защита может применяться к презентация, отдельные слайды, элементы страницы и ввод мастер-редактирования и основные элементы. Фирменные шаблоны и фиксированная графика могут оставаться заблокированными, в то время как выбранные текстовые поля, изображения или объекты диаграмм остаются редактируемыми.
Используйте presentation.getPermission(), slide.getPermission() и slide.getElementPermission(). Мастер-ассоциированные аксессуары предоставляются на Presentation Facade.
Права Slides · Presentation Facade
Relational Table
Разрешения охватывают таблицы, поля, записи, виды и панели инструментов. Когда кто-то редактирует ячейку, реляционная таблица, таблица, поле и ограничения записи применяются вместе. Конфигурация просмотра и панели приборов могут быть защищены отдельно.
Например, защитите схему и финансовые записи, пока люди продолжают выполнять свои повседневные задачи. Таблицы, поля, записи и просмотры разоблачают getPermission(); панели инструментов требуют своего плагина. Фильтрация читаемых полей и записей на пользователя является ответственностью политики чтения данных вашего приложения.
Права Relational Table · API прав объектов
Canvases
Внутри блока холстов Отдельные элементы может быть защищен: формы, текст, изображения и разъемы.Фон архитектуры или структура рабочего процесса могут оставаться защищенными, в то время как сотрудники редактируют только поддерживаемые ими узлы.
Используйте board.getPermission() для блока и board.getElementPermission(elementId) — для отдельных элементов. Редактирование элемента требует разрешения как на уровне холстов, так и на уровне элементов.
Права Canvases · Права элементов
PDF в настоящее время использует режимы просмотра/редактирования для локального взаимодействия, отличного от API Unit и API разрешения объектов, которые используют другие пять продуктов. Бэкэнд разрешает чтение, загрузку и экспорт файлов. PDF также находится за пределами пяти типов Unit, которые поддерживает Core Collaboration.
Интеграция PDF и работа с содержимым
Наследование и политики участников
Грант на объект никогда не отменяет ограничение уровня единицы или соответствующее родительское ограничение. Создание абзаца, поддающегося редактированию, не имеет никакого эффекта, когда документ читается только для поддерживаемых объектов, запрос canEdit() для эффективного результата.
В Docs, Slides, Relational Table и Canvases разрешения на детские объекты в основном контролируют Edit; Copy and Comment настроены на уровне Unit. Листы добавляют рабочие листы и точки разрешения диапазона, поэтому гранулярность отличается по продукту.
Docs, Slides, Relational Table и Canvases предоставляют setObjectPermissions() для установки политики соавтора в партиях:
| Политика | Кто может редактировать объект |
|---|---|
all | Коллаборационисты, которые уже имеют разрешение на редактирование в отделе. |
owner | Владелец объекта, при условии, что Единица и родительские ограничения позволяют это. |
members | Выберите только тех сотрудников, которых вы выбрали. |
Эти политики требуют интеграции Authz, objectPermissionTypes, сконфигурированного для целевых типов, и постоянных привязок объектов, правил и членств. Используйте помощники объект-ID, которые экспортирует SDK, и сохраняйте стабильные идентификаторы контента. policy: null удаляет защиту и восстанавливает наследование. Написание пакетов может быть успешным для некоторых объектов и неудачным для других, поэтому проверьте failed и refreshError. Специализации применяют свои политики через API-интерфейсы защиты рабочих листов и диапазона.
Авторизация на клиенте и сервере
Поддерживайте единую доверенную систему идентификации и политики блока / объекта, которая управляет как внешним поведением, так и разрешением бэкэнда.
| Уровень | Ответственность |
|---|---|
| Web SDK | Читает разрешенные действия текущего пользователя, обновляет точки разрешения и элементы управления редактированием, а также проверяет команды. |
| Authz API приложения | Запросы или изменения политики с использованием доверенной личности, возврат эффективных разрешений на единицу и объект и авторизация управления политикой. |
| Transport | Аутентифицирует файлы cookie, сеансы или учетные данные токенов и устанавливает доверенную личность. Поля пользователей, отправленные клиентом, не являются доказательством авторизации. |
| Endpoint | Авторизует подключение к WebSocket и членство в joinUnit. |
| Service | Проверка читается на readUnitData и в submitChangeset, а также оценивает политику объекта по отношению к затронутому контенту во время применения изменения. |
Server SDK поставляет крюки для промежуточного программного обеспечения; приложение поставляет политики ACL и объекта. Настройки только для чтения и защита объектов на фронтенде не обеспечивают самостоятельное авторизацию бэкэнда. Если приложение проверяет только Редактирование уровня юнит, проверки объектов должны быть добавлены для обеспечения соблюдения ограничений пункта, элемента, поля или записи.
Например, подключите существующий collabService к собственному acl:
import { CollabError } from '@univerjs-pro/collaboration-service'collabService.use('submitChangeset', async (context, next) => { const allowed = await acl.canEdit( context.userID, context.request.changeset.unitID, ) if (!allowed) { throw new CollabError('PERMISSION_DENIED', 'Editing is not allowed') } await next()})Этот пример охватывает только редактирование на уровне юнитов. Чтения, JOIN, изменения политики и конечные точки расширения также нуждаются в защите. Для мелкозернистых записей проверяйте затронутые объекты на этапе приложения, таком как applyChangeset, и сохраняйте политики безопасными для повторного использования.
Для полной интеграции см. удостоверение личности и разрешение. Крюки жизненного цикла описаны в Промежуточное ПО и события .
Насколько полезно это руководство?