Permisos y autorización
Permisos de acciones de Unit, permisos de objetos por producto y autorización en frontend y backend.
Univer separa permisos en dos capas: acciones en una unidad de contenido completo y permisos en objetos dentro de él. El Web SDK utiliza estos permisos para controlar interacciones y ejecución de comandos. El Server SDK define los límites de autorización para lecturas, presentaciones colaborativas y servicios de extensión.
Permisos de la Unit
Un Dependencia es una instancia de contenido completa, como un libro de trabajo, documento, presentación, Tabla de Relación, tablero o PDF. Los permisos de la Unidad se aplican a las Hojas, Docs, Diapositivas, Tabla de Relacion y Canvases. PDF se describe por separado en su propia sección.
| Permiso | Qué controla | Ejemplo |
|---|---|---|
| Editar (Edit) | Cambio de contenido y estructura. | Los lectores leen; los editores rellenan y reorganizan el contenido. |
| Copiar (Copy) | Copiar contenido dentro del editor. | Permitir la lectura y los comentarios evitando la copia. |
| Comentar (Comment) | Inicio de comentarios y respuestas cuando se instalan las funciones de comentario. | Los revisores comentan mientras que el contenido sigue siendo solo leído. |
| Imprimir (Print) | Usando la función de impresión del producto. | Permitir la lectura en línea evitando la impresión. |
| Exportar (Export) | Exportar contenido a un formato de archivo compatible. | Entregar el archivo a otros, o archivarlo. |
Editar y comentar son independientes entre sí. Editar, borrar y gestionar comentarios también siguen las políticas de autor y propietario de su aplicación.
Impresión y exportación también son permisos de nivel unitario. Hojas, Docs, Slides y Canvases exponen ambos; La Tabla Relacional expone actualmente Exportar solamente. Cada permiso funciona con sus correspondientes plugins de características.
Copiar contenido, duplicar un archivo, exportar y descargar son cuatro operaciones separadas. Si un archivo puede abrirse depende de la autorización de lectura de su aplicación.
Por ejemplo, configure por separado los permisos de la Unit de un 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)Registrar el producto y los plugins de comentarios primero. El modo Plugin también requiere @univerjs/docs/facade. Los accesorios de productos se enumeran a continuación. Hojas utiliza sus propios enums de punto de permiso.
El servidor de colaboración Pro comprueba UnitAction.Comment cuando un cambio no vacío contiene sólo las mutaciones integradas de compromiso de rosca: añadir, eliminar, resolver, actualizar o referencia-actualizar. Cambios mixtos, y cualquier mutación que cambie el contenido de documento, incluyendo las decoraciones de comentarios de Docs, todavía requieren UnitAction.Edit. La aplicación también debe hacer cumplir sus propias políticas de autor y propietario de comentarios. Collaboration SDK Servicio Middleware, clasificar los cambios de la misma manera en su submitChangeset policy. A blanket Edit check blocks reviewers who hold only comment permission from submitting comments.
Permisos detallados por producto
Sheets
Los niveles de permisos son libro de trabajo → hoja de trabajo → rango celular. El nivel del libro de trabajo controla la edición, copia y comentario para todo el archivo. Puntos de permiso de hoja restringen valores, estilos, cambios de fila y columna, clasificación, filtrado, tablas de pivotes y objetos adicionales. Controles de protección de rango que pueden editar o ver un área seleccionada, y puede nombrar a los colaboradores que se permiten.
Por ejemplo, proteger las fórmulas presupuestarias y dejar los insumos de gastos editables. Utilice getWorkbookPermission(), getWorksheetPermission() y getRangePermission(). Cree la regla de protección de la hoja de trabajo o rango antes de establecer sus puntos de protección. Cuando el acceso de lectura está restringido, la aplicación también debe controlar los datos que devuelve.
Permisos y protección de Sheets
Docs
Debajo del nivel de documento, secciones, párrafos y entidades de contenido puede ser protegido. Las Entidades incluyen tablas, dibujos, bloques personalizados, y rangos con identificadores estables. Los párrafos de encabezado y de pie se tratan a través de su segmento.
Por ejemplo, proteger las cláusulas contractuales y dejar los párrafos que necesitan ser rellenados en editable. Secciones y párrafos exponen getPermission(); para las entidades, use document.getEntityPermission(). El resultado efectivo combina el documento, cualquier padre aplicable, y las propias reglas del objeto.
Permisos del documento · Permisos de secciones, párrafos y entidades
Slides
La protección se puede aplicar a una presentación, diapositivas individuales, elementos de página, y la entrada de master-editing y elementos maestros. Las plantillas de marca y los gráficos fijos pueden permanecer bloqueados mientras que los cuadros de texto seleccionados, imágenes o objetos de gráfico permanecen editables.
Utilizar presentation.getPermission(), slide.getPermission() y slide.getElementPermission(). Los accesorios relacionados con el maestro son proporcionados por la Facade de Presentación.
Permisos de Slides · Presentation Facade
Relational Table
Las permisos cubren tablas, campos, registros, vistas y tableros de instrumentos. Cuando alguien edita una celda, la Tabla de Relación, tabla, campo y restricciones de registro se aplican juntos. Ver configuración y tableros de control pueden ser protegidos por separado.
Por ejemplo, protege el esquema y los registros financieros mientras la gente sigue manteniendo sus tareas cotidianas. Tablas, campos, registros y vistas exponen getPermission(); los paneles requieren su plugin. Filtrar campos legibles y registros por usuario es la responsabilidad de la política de lectura de datos de su aplicación.
Permisos de Relational Table · API de permisos de objetos
Canvases
Dentro de una Unidad de Canvases, elementos individuales puede ser protegido: formas, texto, imágenes y conectores. Un fondo de arquitectura o un marco de flujo de trabajo pueden permanecer protegidos mientras los colaboradores editan sólo los nodos que mantienen.
Utilizar board.getPermission() para la Unidad y board.getElementPermission(elementId) en elementos individuales. Editar un elemento requiere permiso tanto en el nivel de las islas como en el nivel del elemento.
Permisos de Canvases · Permisos de elementos
PDF utiliza actualmente modos de vista/editar para la interacción local, un alcance diferente de la Unidad y el permiso de objeto API que los otros cinco productos utilizan. El backend autoriza la lectura de archivos, descargas y exportaciones. PDF también está fuera de los cinco tipos de Unidad que Core Collaboration soporta.
Integración y operaciones de PDF
Herencia y políticas de colaboradores
Una subvención de objeto nunca anula una restricción de nivel unitario o una restricción de los padres aplicable. Hacer un párrafo editable no tiene ningún efecto cuando el documento es sólo lectura. Para los objetos soportados, consulta canEdit() para el resultado eficaz.
En Docs, Slides, Relational Table, and Canvases, permisos de objeto de niño controlan principalmente Editar; Copia y Comentario se configuran a nivel de Unidad. Hojas añade hoja de trabajo y puntos de permiso de rango, por lo que la granularidad difiere por producto.
Docs, Slides, Relational Table, and Canvases proporcionan setObjectPermissions() para establecer políticas de colaboradores en lotes:
| Política | Quién puede editar el objeto |
|---|---|
all | Colaboradores que ya tienen permiso de Editar en la Unidad. |
owner | El propietario del objeto, siempre que la Unidad y las restricciones de los padres lo permitan. |
members | Sólo los colaboradores de la Unidad que seleccione. |
Estas políticas requieren la integración de Authz, objectPermissionTypes configurada para los tipos de destino, y las uniones de objetos persistentes, reglas y membresías. Utilice los ayudantes objeto-ID que el SDK exporta y mantiene estables los IDs de contenido. policy: null elimina la protección y restaura la herencia. Una escritura de lotes puede tener éxito para algunos objetos y fallar para otros, así que compruebe failed y refreshError.
Autorización en frontend y backend
Mantenga un sistema de identidad de confianza único y de políticas de unidad/objeto que conduzca tanto el comportamiento de frontend como la autorización de backend.
| Capa | Responsabilidad |
|---|---|
| Web SDK | Lee las acciones permitidas por el usuario actual, actualiza los puntos de permiso y los controles de edición, y comprueba los comandos. |
| API Authz de la aplicación | Consultas o cambios de políticas utilizando la identidad de confianza, devuelve los permisos efectivos de Unidad y objeto, y autoriza la gestión de políticas. |
| Transport | Autentiza las credenciales de Cookies, Sesión o Token y establece la identidad de confianza. Los campos de usuario enviados por el cliente no son pruebas de autorización. |
| Endpoint | Autoriza conexiones WebSocket y miembros de la habitación joinUnit. |
| Service | Los cheques leen a readUnitData y las presentaciones a submitChangeset, y evalúan las políticas de objetos contra el contenido afectado mientras se aplica el cambio. |
El Server SDK suministra ganchos de Middleware; la aplicación suministra las políticas de ACL y objeto. Los ajustes de sólo lectura y la protección del objeto en el frontend no imponen la autorización de backend por sí mismos. Si la aplicación comprueba sólo Editar nivel de unidad, se deben añadir cheques de objetos para hacer cumplir el párrafo, elemento, campo o restricciones de registro.
Por ejemplo, conecte un collabService existente con su propio 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()})Este ejemplo cubre sólo la edición de nivel unitario. Lea, INGRESO, cambios de política y puntos finales de extensión también necesitan protección. Para los escritos finos, validar los objetos afectados en una etapa de aplicación como applyChangeset, y mantener las políticas seguras para volver a entrar.
Para la integración completa, consulte identidad y autorización. Los ganchos de ciclo de vida se describen en Medios y Eventos .
¿Cómo es esta guía?