mirror of
https://github.com/biscuit-auth/biscuit.git
synced 2024-10-26 06:40:35 +03:00
311 lines
5.3 KiB
Protocol Buffer
311 lines
5.3 KiB
Protocol Buffer
syntax = "proto2";
|
|
|
|
package biscuit.format.schema;
|
|
|
|
message Biscuit {
|
|
required bytes authority = 1;
|
|
repeated bytes blocks = 2;
|
|
repeated bytes keys = 3;
|
|
required Signature signature = 4;
|
|
}
|
|
|
|
message SealedBiscuit {
|
|
required bytes authority = 1;
|
|
repeated bytes blocks = 2;
|
|
required bytes signature = 3;
|
|
}
|
|
|
|
message Signature {
|
|
repeated bytes parameters = 1;
|
|
required bytes z = 2;
|
|
}
|
|
|
|
message Block {
|
|
required uint32 index = 1;
|
|
repeated string symbols = 2;
|
|
repeated FactV0 facts_v0 = 3;
|
|
repeated RuleV0 rules_v0 = 4;
|
|
repeated CaveatV0 caveats_v0 = 5;
|
|
optional string context = 6;
|
|
optional uint32 version = 7;
|
|
repeated FactV1 facts_v1 = 8;
|
|
repeated RuleV1 rules_v1 = 9;
|
|
repeated CaveatV1 caveats_v1 = 10;
|
|
}
|
|
|
|
message FactV0 {
|
|
required PredicateV0 predicate = 1;
|
|
}
|
|
|
|
message RuleV0 {
|
|
required PredicateV0 head = 1;
|
|
repeated PredicateV0 body = 2;
|
|
repeated ConstraintV0 constraints = 3;
|
|
}
|
|
|
|
message CaveatV0 {
|
|
repeated RuleV0 queries = 1;
|
|
}
|
|
|
|
message PredicateV0 {
|
|
required uint64 name = 1;
|
|
repeated IDV0 ids = 2;
|
|
}
|
|
|
|
message IDV0 {
|
|
enum Kind {
|
|
SYMBOL = 0;
|
|
VARIABLE = 1;
|
|
INTEGER = 2;
|
|
STR = 3;
|
|
DATE = 4;
|
|
BYTES = 5;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
optional uint64 symbol = 2;
|
|
optional uint32 variable = 3;
|
|
optional int64 integer = 4;
|
|
optional string str = 5;
|
|
optional uint64 date = 6;
|
|
optional bytes bytes = 7;
|
|
}
|
|
|
|
message ConstraintV0 {
|
|
required uint32 id = 1;
|
|
|
|
enum Kind {
|
|
INT = 0;
|
|
STRING = 1;
|
|
DATE = 2;
|
|
SYMBOL = 3;
|
|
BYTES = 4;
|
|
}
|
|
|
|
required Kind kind = 2;
|
|
|
|
optional IntConstraintV0 int = 3;
|
|
optional StringConstraintV0 str = 4;
|
|
optional DateConstraintV0 date = 5;
|
|
optional SymbolConstraintV0 symbol = 6;
|
|
optional BytesConstraintV0 bytes = 7;
|
|
}
|
|
|
|
message IntConstraintV0 {
|
|
enum Kind {
|
|
LOWER = 0;
|
|
LARGER = 1;
|
|
LOWER_OR_EQUAL = 2;
|
|
LARGER_OR_EQUAL = 3;
|
|
EQUAL = 4;
|
|
IN = 5;
|
|
NOT_IN = 6;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
|
|
optional int64 lower = 2;
|
|
optional int64 larger = 3;
|
|
optional int64 lower_or_equal = 4;
|
|
optional int64 larger_or_equal = 5;
|
|
optional int64 equal = 6;
|
|
repeated int64 in_set = 7 [packed=true];
|
|
repeated int64 not_in_set = 8 [packed=true];
|
|
}
|
|
|
|
message StringConstraintV0 {
|
|
enum Kind {
|
|
PREFIX = 0;
|
|
SUFFIX = 1;
|
|
EQUAL = 2;
|
|
IN = 3;
|
|
NOT_IN = 4;
|
|
REGEX = 5;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
|
|
optional string prefix = 2;
|
|
optional string suffix = 3;
|
|
optional string equal = 4;
|
|
repeated string in_set = 5;
|
|
repeated string not_in_set = 6;
|
|
optional string regex = 7;
|
|
}
|
|
|
|
message DateConstraintV0 {
|
|
enum Kind {
|
|
BEFORE = 0;
|
|
AFTER = 1;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
|
|
optional uint64 before = 2;
|
|
optional uint64 after = 3;
|
|
}
|
|
|
|
message SymbolConstraintV0 {
|
|
enum Kind {
|
|
IN = 0;
|
|
NOT_IN = 1;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
|
|
repeated uint64 in_set = 2;
|
|
repeated uint64 not_in_set = 3;
|
|
}
|
|
|
|
message BytesConstraintV0 {
|
|
enum Kind {
|
|
EQUAL = 0;
|
|
IN = 1;
|
|
NOT_IN = 2;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
|
|
optional bytes equal = 2;
|
|
repeated bytes in_set = 3;
|
|
repeated bytes not_in_set = 4;
|
|
}
|
|
|
|
message FactV1 {
|
|
required PredicateV1 predicate = 1;
|
|
}
|
|
|
|
message RuleV1 {
|
|
required PredicateV1 head = 1;
|
|
repeated PredicateV1 body = 2;
|
|
repeated ConstraintV1 constraints = 3;
|
|
}
|
|
|
|
message CaveatV1 {
|
|
repeated RuleV1 queries = 1;
|
|
}
|
|
|
|
message PredicateV1 {
|
|
required uint64 name = 1;
|
|
repeated IDV1 ids = 2;
|
|
}
|
|
|
|
message IDV1 {
|
|
enum Kind {
|
|
SYMBOL = 0;
|
|
VARIABLE = 1;
|
|
INTEGER = 2;
|
|
STR = 3;
|
|
DATE = 4;
|
|
BYTES = 5;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
optional uint64 symbol = 2;
|
|
optional uint32 variable = 3;
|
|
optional int64 integer = 4;
|
|
optional string str = 5;
|
|
optional uint64 date = 6;
|
|
optional bytes bytes = 7;
|
|
}
|
|
|
|
message ConstraintV1 {
|
|
required uint32 id = 1;
|
|
|
|
enum Kind {
|
|
INT = 0;
|
|
STRING = 1;
|
|
DATE = 2;
|
|
SYMBOL = 3;
|
|
BYTES = 4;
|
|
}
|
|
|
|
required Kind kind = 2;
|
|
|
|
optional IntConstraintV1 int = 3;
|
|
optional StringConstraintV1 str = 4;
|
|
optional DateConstraintV1 date = 5;
|
|
optional SymbolConstraintV1 symbol = 6;
|
|
optional BytesConstraintV1 bytes = 7;
|
|
}
|
|
|
|
message IntConstraintV1 {
|
|
enum Kind {
|
|
LESS_THAN = 0;
|
|
GREATER_THAN = 1;
|
|
LESS_OR_EQUAL = 2;
|
|
GREATER_OR_EQUAL = 3;
|
|
EQUAL = 4;
|
|
IN = 5;
|
|
NOT_IN = 6;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
|
|
optional int64 less_than = 2;
|
|
optional int64 greater_than = 3;
|
|
optional int64 less_or_equal = 4;
|
|
optional int64 greater_or_equal = 5;
|
|
optional int64 equal = 6;
|
|
repeated int64 in_set = 7 [packed=true];
|
|
repeated int64 not_in_set = 8 [packed=true];
|
|
}
|
|
|
|
message StringConstraintV1 {
|
|
enum Kind {
|
|
PREFIX = 0;
|
|
SUFFIX = 1;
|
|
EQUAL = 2;
|
|
IN = 3;
|
|
NOT_IN = 4;
|
|
REGEX = 5;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
|
|
optional string prefix = 2;
|
|
optional string suffix = 3;
|
|
optional string equal = 4;
|
|
repeated string in_set = 5;
|
|
repeated string not_in_set = 6;
|
|
optional string regex = 7;
|
|
}
|
|
|
|
message DateConstraintV1 {
|
|
enum Kind {
|
|
BEFORE = 0;
|
|
AFTER = 1;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
|
|
optional uint64 before = 2;
|
|
optional uint64 after = 3;
|
|
}
|
|
|
|
message SymbolConstraintV1 {
|
|
enum Kind {
|
|
IN = 0;
|
|
NOT_IN = 1;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
|
|
repeated uint64 in_set = 2;
|
|
repeated uint64 not_in_set = 3;
|
|
}
|
|
|
|
message BytesConstraintV1 {
|
|
enum Kind {
|
|
EQUAL = 0;
|
|
IN = 1;
|
|
NOT_IN = 2;
|
|
}
|
|
|
|
required Kind kind = 1;
|
|
|
|
optional bytes equal = 2;
|
|
repeated bytes in_set = 3;
|
|
repeated bytes not_in_set = 4;
|
|
}
|