権限と認可
Unit レベルの操作権限、製品ごとのオブジェクト権限、フロントエンドとバックエンドの認可を説明します。
Univerは、全コンテンツ単位でのアクションとオブジェクトの内部の許可の2つのレイヤーにパーミッションを分離します。Web SDKでは、インタラクションとコマンド実行を制御するために、これらのパーミッションを使用します。Server SDK は、読み取り、共同投稿、およびエクステンションサービスに対する認可境界を定義しています。
Unit レベルの権限
ユニットは、ワークブック、ドキュメント、プレゼンテーション、リレーショナルテーブル、ボード、またはPDFなどの1つの完全なコンテンツインスタンスです。 以下にユニットの権限は、シート、ドキュメント、スライド、リレーショナル表、キャンバスに適用されます。 PDFは、独自のセクションで個別に記述されています。
| 権限 | 制御する操作 | 使用例 |
|---|---|---|
| 編集(Edit) | コンテンツや構造の変更。 | ビューアーは、読み取ります。エディタは、入力と並べ替えのコンテンツを埋めます。 |
| コピー(Copy) | エディタ内のコンテンツのコピー。 | コピーを防止しながら読書やコメントをすることができます。 |
| コメント(Comment) | コメント機能がインストールされているときにコメントや返信を開始します。 | コンテンツが読まれたままにコメントしている間、査読者コメント。 |
| 印刷(Print) | 製品のプリント機能を利用する。 | 印刷を防止しながら、オンライン読書を許可します。 |
| エクスポート(Export) | 対応するファイル形式への書き出し。 | ファイルを他の人に配信するか、それをアーカイブします。 |
編集とコメントは、互いに独立しています。 編集、削除、コメントの管理は、アプリケーションの作者と所有者のポリシーに従います。
プリントとエクスポートはユニットレベルの許可です。 シート、ドキュメント、スライド、キャンバスの両方を公開します。 リレーショナルテーブルは現在、エクスポートのみを公開しています。 各許可は、対応する機能プラグインで動作します。
コンテンツをコピーし、ファイルを複製したり、エクスポートしたり、ダウンロードしたりするのは4つの別々の操作です。ファイルが開いたりするかどうかは、アプリケーションの読み込み権限に依存します。
たとえば、Doc の Unit レベルの権限を個別に設定できます。
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サービスミドルウェアを使用する場合、classifyetsはsubmitChangesetポリシーの同じ方法を変更します。 バグ修正コメントのコメントのブロックは、許可者のみを送信します。
製品ごとの詳細な権限
Sheets
権限レベルは、ワークブック → ワークシート → セル範囲です。ワークブックレベルは、ファイルの全体に対する編集、コピー、コメントを制御します。ワークシートのパーミッションポイントは、値、スタイル、行、および列の変更、ソート、フィルタリング、ピボットテーブル、および追加のオブジェクトを制限します。範囲の保護は、選択した領域を編集または表示できるので、許可されているコラビタの名前にすることができます。
例えば、予算の式を保護し、費用の入力を編集可能に残して下さい。getWorkbookPermission()、getWorksheetPermission()およびgetRangePermission()を使用して下さい。保護ポイントを置く前にワークシートか範囲の保護規則を作成して下さい。読まれたアクセスが制限されるとき、適用はそれを返すデータを制御する必要があります。
Docs
文書レベルの下、セクション、段落、コンテンツのエンティティティは保護することができます。 エントリーには、テーブル、図面、カスタムブロック、および安定した識別子の範囲が含まれます。 ヘッダーとフッターの段落は、そのセグメントを介して対処されます。
例えば、契約条項を保護し、編集可能で満たされる必要がある段落を離れます。セクションと段落は、getPermission()を露出します。エンティティティのために、document.getEntityPermission()を使用します。効果的な結果は、文書、任意の適用可能な親、およびオブジェクトの独自のルールを組み合わせます。
Slides
プレゼンテーション、個々のスライド、ページ要素、マスター編集のエントリーとマスター要素に保護を適用することができます。 ブランドのテンプレートと固定グラフィックスは、選択したテキストボックス、画像、またはチャートオブジェクトが編集可能ままにロックを維持することができます。
presentation.getPermission()、slide.getPermission()およびslide.getElementPermission()を使用します。 マスター関連のアクセサは、プレゼンテーションファサードによって提供されます。
Slides の権限 · Presentation Facade
Relational Table
許可はテーブル、フィールド、レコード、ビュー、ダッシュボードをカバーします。誰かがセルを編集するとき、リレーショナルテーブル、テーブル、フィールド、およびレコードの制限が一緒に適用されます。構成とダッシュボードの表示は別々に保護することができます。
たとえば、スキーマと財務記録を保護し、人々は日々のタスクを維持し続けます。テーブル、フィールド、レコード、ビューは、getPermission()を露出します。ダッシュボードには、プラグインが必要です。読み取り可能なフィールドとユーザーごとのレコードをフィルタリングすると、アプリケーションのデータ読み取りポリシーの責任です。
Relational Table の権限 · オブジェクト権限 API
Canvases
キャンバスユニット内で、個々の要素は、形状、テキスト、画像、およびコネクタから保護することができます。アーキテクチャの背景またはワークフローフレームワークは、共同作業者が維持するノードだけを編集しながら保護することができます。
board.getPermission() は、個々の要素のユニットとboard.getElementPermission(elementId)に使用します。要素を編集するには、キャンバスレベルと要素レベルの両方で許可が必要です。
PDFは現在、ビュー/編集モードをローカルインタラクション、他の5つの製品が使用するユニットとオブジェクトパーミッションAPIの異なるスコープに使用しています。 バックエンドは、ファイル読み取り、ダウンロード、およびエクスポートを承認します。 PDFは、コアコラボレーションがサポートする5つのユニットタイプ外にあります。
権限の継承と共同編集者のポリシー
オブジェクトの付与は、ユニットレベルの制限または適用可能な親制限を上書きしません。 段落の編集可能にする、ドキュメントが読み取り専用であるときには効果がありません。サポートされているオブジェクトについては、効果的な結果の canEdit(). をクエリします。
Docs、スライド、リレーショナルテーブル、キャンバスでは、主にEdit; Copyとコメントをコントロールする子オブジェクトの権限がユニットレベルで構成されます。シートはワークシートと範囲のパーミッションポイントを追加します。そのため、粒度は製品によって異なります。
Docs、スライド、リレーショナルテーブル、キャンバスは、setObjectPermissions() を提供して、バッチでコラベーターポリシーを設定する:
| ポリシー | 編集可能なユーザー |
|---|---|
all | 既にユニットの編集権限を保持しているコラビエーター。 |
owner | オブジェクトの所有者は、ユニットと親の制限を提供して、それを許可します。 |
members | 選択したユニットの共同作業者のみ。 |
これらの方針は、Authz の統合、ターゲット タイプのために構成される objectPermissionTypes および持続させた目的の結合、規則およびメンバーを要求します。SDK の輸出および内容 ID を安定した保つ目的 ID のヘルパーを使用して下さい。 policy: null は保護を取除き、相続を元通りにします。 バッチ ライティングはある目的のために成功し、他のために失敗できます、従って failed および refreshError を点検して下さい。 シートはワークシートおよび範囲の保護 API を通してポリシーを適用します。
フロントエンドとバックエンドの認可
フロントエンドの動作とバックエンドの承認を駆動する単一の信頼できるアイデンティティとユニット/オブジェクトポリシーシステムを維持します。
| 層 | 役割 |
|---|---|
| Web SDK | 現在のユーザの許可されたアクションを読み込み、パーミッションポイントを更新し、コントロールを編集し、コマンドをチェックします。 |
| アプリケーションの Authz API | 信頼できるアイデンティティを使用してポリシーを変更したり変更したり、効果的なユニットとオブジェクトの権限を返し、ポリシー管理を承認します。 |
| Transport | クッキー、セッション、またはトークン認証を認証し、信頼できるアイデンティティを確立します。 クライアントが送信するユーザーフィールドは、認証証拠ではありません。 |
| 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などのアプリケーションステージで検証し、ポリシーを安全に再試行させます。
完全な統合については、アイデンティティと権限を参照してください。 ライフサイクルのホックはミドルウェアとイベントで記述されています。
このガイドはいかがですか?