Permissions et autorisation
Permissions des actions de Unit, permissions des objets par produit et autorisation côté client et serveur.
Univer sépare les permissions en deux couches : actions sur une unité de contenu et permissions sur les objets à l'intérieur. Le Web SDK utilise ces permissions pour contrôler les interactions et l'exécution des commandes. Le Server SDK définit les limites d'autorisation pour les lectures, les soumissions collaboratives et les services d'extension.
Permissions de la Unit
Un Unité est une instance de contenu complète, comme un cahier de travail, un document, une présentation, une table de discussion, une planche ou un PDF. Les permissions de l'unité ci-dessous s'appliquent aux feuilles, aux docs, aux diapositives, à la table de discussion et aux toiles.
| Permission | Opérations contrôlées | Exemple |
|---|---|---|
| Éditer (Edit) | Changement de contenu et de structure. | Les téléspectateurs lisent; les éditeurs remplissent et réarrangent le contenu. |
| Copier (Copy) | Copier le contenu dans l'éditeur. | Permettre la lecture et les commentaires tout en empêchant la copie. |
| Commenter (Comment) | Démarrage des commentaires et des réponses lorsque les fonctionnalités de commentaires sont installées. | Les évaluateurs commentent alors que le contenu reste en lecture seule. |
| Imprimer (Print) | Utilisation de la fonction d'impression du produit. | Permettre la lecture en ligne tout en empêchant l'impression. |
| Exporter (Export) | Exporter le contenu dans un format de fichier compatible. | Livrez le fichier à d'autres, ou l'archivez-le. |
L'édition et les commentaires sont indépendants les uns des autres. L'édition, la suppression et la gestion des commentaires suivent également les politiques de l'auteur et du propriétaire de votre application.
Les feuilles, les Docs, les diapositives et les toiles exposent les deux; Relasional Table expose actuellement l'Export seulement. Chaque autorisation fonctionne avec ses plugins de fonctionnalités correspondants.
La copie du contenu, la duplication d'un fichier, l'exportation et le téléchargement sont quatre opérations distinctes.
Par exemple, configurez séparément les permissions de la Unit d’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)Enregistrez d'abord les plugins produits et commentaires. Le mode plugin nécessite également @univerjs/docs/facade. Les accessoires produits sont listés ci-dessous.
Le serveur de collaboration Pro vérifie UnitAction.Comment lorsqu'un changement non vide ne contient que les mutations thread-comment intégrées: ajouter, supprimer, résoudre, mettre à jour ou mettre à jour de référence. Les changements mixtes et toute mutation qui modifie le contenu du document, y compris les décorations de commentaires Docs, nécessitent toujours UnitAction.Edit. L'application doit également faire appliquer ses propres politiques d'auteur de commentaires et de propriétaire. Collaboration SDK Service Middleware, classifier les changements de la même façon dans votre submitChangeset Politique. Une couverture Modifier les blocs de contrôle des évaluateurs qui ne détiennent que la permission de commenter de soumettre des commentaires.
Permissions détaillées par produit
Sheets
Les niveaux de permission sont workbook → worksheet → gamme de cellules. Le classeur contrôle l'édition, la copie et le commentaire de tout le fichier. Les points d'autorisation de la feuille de travail limitent les valeurs, les styles, les changements de lignes et de colonnes, le tri, le filtrage, les tables de pivot et les objets supplémentaires.
Par exemple, protégez les formules budgétaires et laissez les entrées de dépenses modifiables. Utilisez getWorkbookPermission(), getWorksheetPermission() et getRangePermission(). Créez la feuille de travail ou la règle de protection de la plage avant de définir ses points de protection. Lorsque l'accès à la lecture est restreint, l'application doit également contrôler les données qu'elle retourne.
Permissions et protection de Sheets
Docs
En dessous du niveau du document, sections, paragraphes et entités de contenu peut être protégé. Les entités comprennent des tableaux, des dessins, des blocs personnalisés et des gammes avec des identifiants stables.
Par exemple, protégez les clauses contractuelles et laissez les paragraphes qui doivent être remplis dans modifiables. Les sections et paragraphes exposent getPermission(); pour les entités, utilisez document.getEntityPermission(). Le résultat effectif combine le document, tout parent applicable et les propres règles de l'objet.
Permissions du document · Permissions des sections, paragraphes et entités
Slides
La protection peut s'appliquer à une présentation, des diapositives individuelles, des éléments de page, ainsi que l'entrée maître-édition et les éléments maîtres. Les modèles de marque et les graphiques fixes peuvent rester verrouillés pendant que les boîtes de texte, les images ou les objets graphiques sélectionnés restent modifiables.
Utilisez presentation.getPermission(), slide.getPermission() et slide.getElementPermission(). Les accesseurs associés au Master sont fournis par la Facade de présentation.
Permissions de Slides · Presentation Facade
Relational Table
Les permissions couvrent tableaux, champs, enregistrements, vues et tableaux de bord. Lorsque quelqu'un modifie une cellule, les restrictions de la table, du champ et de l'enregistrement sont appliquées ensemble. La configuration et les tableaux de bord peuvent être protégés séparément.
Par exemple, protégez le schéma et les dossiers financiers pendant que les gens continuent à maintenir leurs tâches quotidiennes. Les tables, les champs, les dossiers et les vues exposent getPermission(); les tableaux de bord nécessitent leur plugin. Le filtrage des champs et des dossiers lisibles par utilisateur est la responsabilité de la politique de lecture des données de votre application.
Permissions de Relational Table · API des permissions d’objets
Canvases
Au sein d'une unité de toiles, Éléments individuels peut être protégé : formes, texte, images et connecteurs. Un arrière-plan de l'architecture ou un cadre de travail peut rester protégé pendant que les collaborateurs ne modifient que les nœuds qu'ils maintiennent.
Utilisez board.getPermission() pour l'unité et board.getElementPermission(elementId) sur des éléments individuels. L'édition d'un élément nécessite une autorisation tant au niveau des Toiles qu'au niveau des éléments.
Permissions de Canvases · Permissions des éléments
PDF utilise actuellement mode de visionnement/modification pour l'interaction locale, une portée différente de l'unité et des API de permission d'objets que les cinq autres produits utilisent. Le moteur autorise la lecture, le téléchargement et l'exportation de fichiers. PDF est également en dehors des cinq types d'unité que Core Collaboration supporte.
Héritage et politiques des collaborateurs
Une subvention d'objet ne remplace jamais une restriction au niveau de l'unité ou une restriction parentale applicable. Faire un paragraphe modifiable n'a aucun effet lorsque le document est en lecture seule. Pour les objets pris en charge, demandez canEdit() pour le résultat effectif.
Dans Docs, Diapositives, Table Relationnelle, et Toiles, les permissions d'objets pour enfants contrôlent principalement Édition; Copie et Commentaire sont configurés au niveau de l'unité. Les feuilles ajoutent des points de permission de feuille de travail et de plage, donc la granularité diffère par produit.
Docs, Diapositives, Table Relationnelle et Toiles fournissent setObjectPermissions() pour définir des politiques de collaborateurs en lots :
| Politique | Qui peut éditer l’objet |
|---|---|
all | Collaborateurs qui détiennent déjà la permission d'éditer sur l'unité. |
owner | Le propriétaire de l'objet, à condition que l'unité et les restrictions parentales le permettent. |
members | Seuls les collaborateurs de l'Unité que vous choisissez. |
Ces politiques nécessitent l'intégration d'Authz, objectPermissionTypes configuré pour les types de cibles, et persistent les liaisons, les règles et les adhésions d'objets. Utilisez les helpers objet-ID que le SDK exporte et garde les ID de contenu stable. policy: null supprime la protection et restaure l'héritage. Une écriture par lots peut réussir pour certains objets et échouer pour d'autres, alors vérifiez failed et refreshError. Les feuilles appliquent ses politiques à travers la feuille de travail et les API de protection de plage.
Autorisation côté client et serveur
Maintenir une identité de confiance unique et un système de politique d'unité/objet qui stimule à la fois le comportement frontend et l'autorisation de moteur.
| Couche | Responsabilité |
|---|---|
| Web SDK | Lit les actions autorisées par l'utilisateur actuel, met à jour les points d'autorisation et les contrôles d'édition, et vérifie les commandes. |
| API Authz de l’application | Interroge ou modifie les politiques en utilisant l'identité de confiance, renvoie les permissions efficaces de l'unité et des objets, et autorise la gestion des politiques. |
| Transport | Authentifie les identifiants de Cookie, Session ou Token et établit l'identité de confiance. Les champs utilisateur envoyés par le client ne sont pas des preuves d'autorisation. |
| Endpoint | Autorise les connexions WebSocket et l'adhésion à la salle joinUnit. |
| Service | Vérifie la lecture à la readUnitData et les soumissions à la submitChangeset, et évalue les politiques d'objet par rapport au contenu affecté pendant que le jeu de modifications est appliqué. |
Le Server SDK fournit des crochets Middleware; l'application fournit les politiques ACL et objet. Les paramètres en lecture seule et la protection des objets sur la façade ne font pas appliquer l'autorisation de backend par eux-mêmes. Si l'application ne vérifie que l'édition au niveau de l'unité, les vérifications objet doivent être ajoutées pour faire respecter les restrictions de paragraphe, d'élément, de champ ou d'enregistrement.
Par exemple, reliez un collabService existant à votre propre 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()})Cet exemple ne couvre que l'édition au niveau de l'unité. Reads, JOIN, les changements de politique et les paramètres d'extension ont besoin de protection. Pour les écritures à grain fin, validez les objets affectés dans une étape d'application comme applyChangeset, et gardez les politiques en sécurité pour les réessayer.
Pour l'intégration complète, voir identité et autorisation. Les crochets de cycle de vie sont décrits dans Middleware et événements .
Que pensez-vous de ce guide ?