proto: Capability ベースの権限管理機能 PWA 版ではワークスペースの管理はフルにできるが、デスクトップ版では ワークスペース = ファイルとなるためアプリケーション側から削除、 というのはあまりよろしくないので見せたくない。将来的なマルチユーザ なクラウド環境を考えても権限・サポートを capability として表現すれ ば UI 的にも API 的にも堅実に実装・設計ができる。 セキュリティコンテキストにおける capability の丁度いい日本語が 見つからない...。

Changes

9 changed files (+59/-0)

• packages/proto/yamori/capability/v1/capability_key.proto (new)
  • @@ -0,0 +1,12 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.capability.v1; + + // アクセス許可キー。 + message CapabilityKey { + // キーを識別・検証するための任意のバイト列。 + bytes key = 1; + }
• packages/proto/yamori/error/v1/capability_error.proto (new)
  • @@ -0,0 +1,13 @@
    + // SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com> + // SPDX-License-Identifier: AGPL-3.0-only + + edition = "2023"; + + package yamori.error.v1; + + message CapabilityError { + // エラーの原因となったキーのパス。セキュリティのため空の場合もある。 + // 記法は google.protobuf.FieldMask と同様。 + // <https://github.com/protocolbuffers/protobuf/blob/5d0865cf1537772b8e0969563402654087b40d31/src/google/protobuf/field_mask.proto> + string path = 1; + }
• packages/proto/yamori/worker/v1/create_request.proto
  • @@ -5,6 +5,7 @@ edition = "2023";
    package yamori.worker.v1; + import "yamori/capability/v1/capability_key.proto"; import "yamori/idempotency/v1/key.proto"; import "yamori/workspace/v1/workspace_id.proto";
  • @@ -16,4 +17,7 @@ yamori.workspace.v1.WorkspaceID workspace_id = 2;
    // [必須] 労働者の表示名。 string display_name = 3; + + // [必須] 労働者の登録を行うための対象ワークスペースのキー。 + yamori.capability.v1.CapabilityKey worker_add_key = 4; }
• packages/proto/yamori/worker/v1/create_response.proto
  • @@ -5,6 +5,7 @@ edition = "2023";
    package yamori.worker.v1; + import "yamori/error/v1/capability_error.proto"; import "yamori/error/v1/missing_field_error.proto"; import "yamori/error/v1/system_error.proto"; import "yamori/worker/v1/worker.proto";
  • @@ -27,5 +28,8 @@ yamori.error.v1.SystemError system_error = 3;
    // 必須フィールドに値が入っていないため作成されなかった。 yamori.error.v1.MissingFieldError missing_field = 4; + + // 権限がない、もしくはキーが不正。 + yamori.error.v1.CapabilityError capability_error = 5; } }
• packages/proto/yamori/workspace/v1/delete_request.proto
  • @@ -5,9 +5,13 @@ edition = "2023";
    package yamori.workspace.v1; + import "yamori/capability/v1/capability_key.proto"; import "yamori/workspace/v1/workspace_id.proto"; message DeleteRequest { // [必須] 削除対象のワークスペースの ID 。 WorkspaceID id = 1; + + // [必須] 削除を行うためのキー。 + yamori.capability.v1.CapabilityKey deletion_key = 2; }
• packages/proto/yamori/workspace/v1/delete_response.proto
  • @@ -5,6 +5,7 @@ edition = "2023";
    package yamori.workspace.v1; + import "yamori/error/v1/capability_error.proto"; import "yamori/error/v1/missing_field_error.proto"; import "yamori/error/v1/not_found.proto"; import "yamori/error/v1/system_error.proto";
  • @@ -29,5 +30,8 @@ // 削除対象のワークスペースが見つからない。
    // - ID がおかしい // - 既に削除された yamori.error.v1.NotFound not_found = 4; + + // 権限がない、もしくはキーが不正。 + yamori.error.v1.CapabilityError capability_error = 5; } }
• packages/proto/yamori/workspace/v1/update_request.proto
  • @@ -6,6 +6,7 @@
    package yamori.workspace.v1; import "google/protobuf/field_mask.proto"; + import "yamori/capability/v1/capability_key.proto"; import "yamori/workspace/v1/workspace_id.proto"; message UpdateRequest {
  • @@ -19,4 +20,7 @@ // 更新するフィールドの一覧。
    // 有効なパス: // - `display_name` google.protobuf.FieldMask field_mask = 3; + + // [必須] ワークスペース自体の情報の更新を行うためのキー。 + yamori.capability.v1.CapabilityKey update_key = 4; }
• packages/proto/yamori/workspace/v1/update_response.proto
  • @@ -5,6 +5,7 @@ edition = "2023";
    package yamori.workspace.v1; + import "yamori/error/v1/capability_error.proto"; import "yamori/error/v1/missing_field_error.proto"; import "yamori/error/v1/not_found.proto"; import "yamori/error/v1/system_error.proto";
  • @@ -29,5 +30,8 @@ // 更新対象のワークスペースが見つからない。
    // - ID がおかしい // - 既に削除された yamori.error.v1.NotFound not_found = 4; + + // 権限がない、もしくはキーが不正。 + yamori.error.v1.CapabilityError capability_error = 5; } }
• packages/proto/yamori/workspace/v1/workspace.proto
  • @@ -5,6 +5,7 @@ edition = "2023";
    package yamori.workspace.v1; + import "yamori/capability/v1/capability_key.proto"; import "yamori/workspace/v1/workspace_id.proto"; // 労働者や勤怠記録といった全てのデータの管理単位。
  • @@ -15,4 +16,13 @@
    // ワークスペースの表示名。ユーザが選択する際などに識別 // するための human readable な名前。 string display_name = 2; + + // ワークスペース自体の情報の更新を行うためのキー。 + yamori.capability.v1.CapabilityKey update_key = 3; + + // 削除を行うためのキー。 + yamori.capability.v1.CapabilityKey deletion_key = 4; + + // 労働者の登録を行うためのキー。 + yamori.capability.v1.CapabilityKey worker_add_key = 5; }