Zum Hauptinhalt springen

Schreibbeschränkung (writeAccess)

Ein Typ kann festlegen, wer seine Laufzeit-Entitäten schreiben darf. Mit einem writeAccess-Block dürfen nur die aufgeführten Principal-Arten und vertrauenswürdigen Service-Kanäle Entitäten des Typs anlegen, ändern, ersetzen oder löschen oder Assoziationen ändern, an deren einem Ende eine solche Entität steht. Alle anderen werden mit Meldung 144 abgelehnt, und es wird nichts geschrieben.

Der Block setzt ckLanguage: 2 voraus.

types:
- typeId: KnowledgePage
derivedFromCkTypeId: ${System}/Entity
writeAccess:
principals: [ Interactive ]
channels: [ System.Ai/KnowledgeTools ]
SchlüsselWerteWer schreiben darf
principalsInteractive, Client (genaue Schreibweise)Interactive: ein angemeldeter Benutzer. Client: ein Service, der sich mit Client Credentials authentifiziert hat.
channels<namespace>/<name>, zum Beispiel System.Ai/KnowledgeToolsEin Service, der über seinen eigenen abgesicherten Codepfad schreibt und seine Session mit diesem Kanal markiert.

Ein Schreibvorgang ist erlaubt, wenn die Principal-Art des Aufrufers aufgeführt ist oder seine Session einen aufgeführten Kanal trägt.

Regeln​

  • Abgeleitete Typen erben den Block. Deklariert ein abgeleiteter Typ zusätzlich einen eigenen Block, muss jeder Block entlang der Vererbungskette den Schreibvorgang erlauben. Ein abgeleiteter Typ kann die Beschränkung enger machen, aber nie weiter.
  • Assoziationen zählen als Schreibvorgang. Wer eine Assoziation hinzufügt oder entfernt, deren Quelle oder Ziel eine beschränkte Entität ist, braucht das Recht, diese Entität zu schreiben.
  • Schreibvorgänge des Systems sind nie beschränkt. Pipelines, Seed-Daten von Blueprints, Blueprint-Updates und CK-Modell-Migrationen schreiben als System und funktionieren weiter.
  • Typen ohne eigenen Block und ohne Block eines Basistyps bleiben unverändert. Bei ihnen spielt es keine Rolle, welche Art von Aufrufer schreibt.
  • Keine Client-Ids im Modell. Client-Ids unterscheiden sich zwischen Tenants und Clustern. Ein Kanal ist keine Client-Id: Der Service setzt ihn in seinem eigenen Code auf die Session, die er öffnet. Er stammt nie aus einem Token, einem Header oder sonst etwas, das der Aufrufer schickt.

Wo die Beschränkung gilt​

Die Engine prüft die Beschränkung bei jedem Schreibvorgang, den ein Benutzer oder ein Service für einen Aufrufer ausführt:

  • GraphQL-Mutationen zum Anlegen, Ändern und Löschen und REST-Schreibvorgänge,
  • Laufzeit-Importe, die ein Benutzer oder Client startet (ImportRt): Die ganze Datei wird abgelehnt, bevor etwas geschrieben wird, mit einem Fehler, der jede abgelehnte Entität auflistet.

Der Service, der die Session öffnet, teilt der Engine mit, ob der Aufrufer ein interaktiver Benutzer oder ein Client ist. Weiß er es nicht, wird der Aufrufer bei beschränkten Typen abgelehnt (er kommt nur über einen aufgeführten Kanal durch).

Unterstützung durch die Services

Ab Release 3.5.71 meldet das Asset-Repository die Art des Aufrufers für Schreibvorgänge über GraphQL und REST, und bei Runtime-Importen, die ein Benutzer oder Client startet, gibt es sie an den Import-Job weiter, den die Bot-Services ebenfalls ab Release 3.5.71 anwenden (beide Services müssen 3.5.71 haben; ein älterer Bot-Service importiert als Unknown): Ein Token mit Benutzer-Subject (sub) ist Interactive; ein Client-Credentials-Token und ein Token, mit dem ein Service für einen Benutzer handelt (Delegation oder Impersonation), ist Client; alles andere ist Unknown. Gemischte Versionen: Mit einem älteren Asset-Repository ist jeder Aufrufer über GraphQL, REST und Import Unknown; mit einem älteren Bot-Service laufen nur Runtime-Importe als Unknown, Schreibvorgänge über GraphQL und REST werden eingeordnet. Unknown wird nur über einen aufgeführten Kanal zugelassen. Importe, die vor dem Upgrade eingereiht wurden, laufen ebenfalls weiter als Unknown. Beschränken Sie einen Typ, den Benutzer oder Clients weiter schreiben müssen, deshalb erst, wenn das Asset-Repository und die Bot-Services Ihrer Umgebung 3.5.71 haben und die vor dem Upgrade eingereihten Import-Jobs abgeschlossen oder neu eingereiht sind (siehe Status).

Prüfungen des Compilers​

Der Compiler lehnt einen ungültigen Block mit Meldung 143 ab:

  • ein Block, der weder principals noch channels aufführt,
  • eine leere Liste principals oder channels,
  • eine Principal-Art außer Interactive oder Client,
  • ein Kanal, der nicht die Form <namespace>/<name> hat (Buchstaben, Ziffern und Unterstriche; jeder Teil beginnt mit einem Buchstaben; der Namespace darf Punkte enthalten),
  • derselbe Eintrag zweimal.

Ein unbekannter Schlüssel im Block ist ein Schemafehler (Meldung 27). In einem Modell ohne ckLanguage: 2 ist der Block Meldung 90.

Kompatibilität​

  • Ein Modell mit writeAccess braucht die Engine 3.5.71 oder neuer (minEngineVersion). Ältere Release-Engines lehnen das Modell mit Meldung 126 ab, statt die Beschränkung zu ignorieren. Main-Line-Builds unter Version 1.0 überspringen diese Prüfung (siehe Vertrag zur Engine-Version); importieren Sie ein solches Modell dort erst, wenn alle Services eine Engine haben, die writeAccess kennt.
  • Einen Block hinzuzufügen, zu entfernen oder zu ändern ist eine Minor-Änderung, die mit einem Sicherheitsgrund bestätigt werden muss (compatibility.acknowledge), siehe die Versionierungsregeln.
  • Modelle ohne den Block werden genau wie bisher kompiliert.