1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
//! Schema, which can be used to encode/decode a document or entry, while verifying its
//! contents.
//!
//! A schema is always decoded from a [`Document`][crate::document::Document]. Schema documents can
//! be easily built from scratch using a [`SchemaBuilder`].
//!
use std::{
collections::BTreeMap,
convert::{TryFrom, TryInto},
};
use crate::document::*;
use crate::entry::*;
pub use compress::*;
use element::Parser;
use query::{NewQuery, Query};
use crate::error::{Error, Result};
use crate::validator::{Checklist, DataChecklist, Validator};
use crate::*;
use serde::{Deserialize, Serialize};
#[inline]
fn compress_is_default(val: &Compress) -> bool {
if let Compress::General { algorithm, level } = val {
*algorithm == ALGORITHM_ZSTD && *level == 3
} else {
false
}
}
#[inline]
fn int_is_zero(v: &Integer) -> bool {
v.as_u64().map(|v| v == 0).unwrap_or(false)
}
#[inline]
fn u8_is_zero(v: &u8) -> bool {
*v == 0
}
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
struct InnerSchema {
doc: Validator, // required
#[serde(skip_serializing_if = "String::is_empty", default)]
description: String,
#[serde(skip_serializing_if = "compress_is_default", default)]
doc_compress: Compress,
#[serde(skip_serializing_if = "BTreeMap::is_empty", default)]
entries: BTreeMap<String, EntrySchema>,
#[serde(skip_serializing_if = "String::is_empty", default)]
name: String,
#[serde(skip_serializing_if = "BTreeMap::is_empty", default)]
types: BTreeMap<String, Validator>,
#[serde(skip_serializing_if = "int_is_zero", default)]
version: Integer,
#[serde(skip_serializing_if = "u8_is_zero", default)]
max_regex: u8,
}
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
struct EntrySchema {
entry: Validator, // required
#[serde(skip_serializing_if = "compress_is_default", default)]
compress: Compress,
}
/// Validation for documents without a schema.
///
/// Not all documents adhere to a schema, but they must still be verified for correctness and be
/// optionally compressed on encoding. This `NoSchema` struct acts like a Schema to accomplish
/// this.
///
/// As schemaless documents cannot have attached entries, `NoSchema` does not do any entry
/// encode/decode.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct NoSchema;
impl NoSchema {
/// Validate a [`NewDocument`], turning it into a [`Document`]. Fails if the internal data
/// isn't actually valid fog-pack, which can sometimes happen with a bad Serialize
/// implementation for the data.
pub fn validate_new_doc(doc: NewDocument) -> Result<Document> {
// Check that this document doesn't have a schema
if let Some(schema) = doc.schema_hash() {
return Err(Error::SchemaMismatch {
actual: Some(schema.to_owned()),
expected: None,
});
}
// Cursory validation of the data
let types = BTreeMap::new();
let parser = Parser::new(doc.data());
let (parser, _) = Validator::Any.validate(&types, parser, None)?;
parser.finish()?;
Ok(Document::from_new(doc))
}
/// Re-encode a validated [`Document`], returning the resulting Document's hash and fully encoded
/// format.
pub fn encode_doc(doc: Document) -> Result<(Hash, Vec<u8>)> {
// Check that this document doesn't have a schema
if let Some(schema) = doc.schema_hash() {
return Err(Error::SchemaMismatch {
actual: Some(schema.to_owned()),
expected: None,
});
}
// Compress the document
let (hash, doc, compression) = doc.complete();
let compression = match compression {
None => Compress::General {
algorithm: 0,
level: 3,
},
Some(None) => Compress::None,
Some(Some(level)) => Compress::General {
algorithm: 0,
level,
},
};
Ok((hash, compress_doc(doc, &compression)))
}
/// Decode a document that doesn't have a schema.
pub fn decode_doc(doc: Vec<u8>) -> Result<Document> {
// Check for hash
let split = SplitDoc::split(&doc)?;
if !split.hash_raw.is_empty() {
return Err(Error::SchemaMismatch {
actual: split.hash_raw.try_into().ok(),
expected: None,
});
}
// Decompress
let doc = Document::new(decompress_doc(doc, &Compress::None)?)?;
// Validate
let types = BTreeMap::new();
let parser = Parser::new(doc.data());
let (parser, _) = Validator::Any.validate(&types, parser, None)?;
parser.finish()?;
Ok(doc)
}
/// Decode a Document, skipping any checks of the data. This should only be run when the raw
/// document has definitely been passed through validation before, i.e. if it is stored in a
/// local database after going through [`encode_doc`][Self::encode_doc].
pub fn trusted_decode_doc(doc: Vec<u8>) -> Result<Document> {
// Check for hash
let split = SplitDoc::split(&doc)?;
if !split.hash_raw.is_empty() {
return Err(Error::SchemaMismatch {
actual: split.hash_raw.try_into().ok(),
expected: None,
});
}
// Decompress
let doc = Document::new(decompress_doc(doc, &Compress::None)?)?;
Ok(doc)
}
}
fn compress_doc(doc: Vec<u8>, compression: &Compress) -> Vec<u8> {
// Skip if we aren't compressing
if let Compress::None = compression {
return doc;
}
// Gather info from the raw document
let split = SplitDoc::split(&doc).unwrap();
let header_len = doc.len() - split.data.len() - split.signature_raw.len();
let max_len = zstd_safe::compress_bound(split.data.len());
let mut compress = Vec::with_capacity(doc.len() + max_len - split.data.len());
compress.extend_from_slice(&doc[..header_len]);
// Compress, update the header, append the signature
match compression.compress(compress, split.data) {
Ok(mut compress) => {
let data_len = (compress.len() - header_len).to_le_bytes();
compress[0] = CompressType::type_of(compression).into();
compress[header_len - 3] = data_len[0];
compress[header_len - 2] = data_len[1];
compress[header_len - 1] = data_len[2];
compress.extend_from_slice(split.signature_raw);
compress
}
Err(()) => doc,
}
}
fn decompress_doc(compress: Vec<u8>, compression: &Compress) -> Result<Vec<u8>> {
// Gather info from compressed vec
let split = SplitDoc::split(&compress)?;
let marker = CompressType::try_from(split.compress_raw)
.map_err(|m| Error::BadHeader(format!("unrecognized compression marker 0x{:x}", m)))?;
if let CompressType::None = marker {
return Ok(compress);
}
let header_len = compress.len() - split.data.len() - split.signature_raw.len();
// Decompress, update the header, append the signature
let mut doc = Vec::new();
doc.extend_from_slice(&compress[..header_len]);
let mut doc = compression.decompress(
doc,
split.data,
marker,
split.signature_raw.len(),
MAX_DOC_SIZE,
)?;
let data_len = (doc.len() - header_len).to_le_bytes();
doc[0] = CompressType::None.into();
doc[header_len - 3] = data_len[0];
doc[header_len - 2] = data_len[1];
doc[header_len - 1] = data_len[2];
doc.extend_from_slice(split.signature_raw);
Ok(doc)
}
fn compress_entry(entry: Vec<u8>, compression: &Compress) -> Vec<u8> {
// Skip if we aren't compressing
if let Compress::None = compression {
return entry;
}
// Gather info from the raw entry
let split = SplitEntry::split(&entry).unwrap();
let max_len = zstd_safe::compress_bound(split.data.len());
let mut compress = Vec::with_capacity(entry.len() + max_len - split.data.len());
compress.extend_from_slice(&entry[..ENTRY_PREFIX_LEN]);
// Compress, update the header, append the signature
match compression.compress(compress, split.data) {
Ok(mut compress) => {
let data_len = (compress.len() - ENTRY_PREFIX_LEN).to_le_bytes();
compress[0] = CompressType::type_of(compression).into();
compress[1] = data_len[0];
compress[2] = data_len[1];
compress.extend_from_slice(split.signature_raw);
compress
}
Err(()) => entry,
}
}
fn decompress_entry(compress: Vec<u8>, compression: &Compress) -> Result<Vec<u8>> {
// Gather info from compressed vec
let split = SplitEntry::split(&compress)?;
let marker = CompressType::try_from(split.compress_raw)
.map_err(|m| Error::BadHeader(format!("unrecognized compression marker 0x{:x}", m)))?;
if let CompressType::None = marker {
return Ok(compress);
}
// Decompress, update the header, append the signature
let mut entry = Vec::new();
entry.extend_from_slice(&compress[..ENTRY_PREFIX_LEN]);
let mut entry = compression.decompress(
entry,
split.data,
marker,
split.signature_raw.len(),
MAX_ENTRY_SIZE,
)?;
let data_len = (entry.len() - ENTRY_PREFIX_LEN).to_le_bytes();
entry[0] = CompressType::None.into();
entry[1] = data_len[0];
entry[2] = data_len[1];
entry.extend_from_slice(split.signature_raw);
Ok(entry)
}
/// Builds schemas up from Validators.
///
/// A schema can be directly made from any document, but it's generally much easier to construct
/// them from [`Validator`][crate::validator::Validator] structs and turn the result into a
/// Document.
#[derive(Clone, Debug)]
pub struct SchemaBuilder {
inner: InnerSchema,
}
impl SchemaBuilder {
/// Start building a new schema. Requires the validator to use for any documents adhering to
/// this schema.
pub fn new(doc: Validator) -> Self {
Self {
inner: InnerSchema {
doc,
description: String::default(),
doc_compress: Compress::default(),
entries: BTreeMap::new(),
name: String::default(),
types: BTreeMap::new(),
version: Integer::default(),
max_regex: 0,
},
}
}
/// Set the schema description. This is only used for documentation purposes.
pub fn description(mut self, description: &str) -> Self {
self.inner.description = description.to_owned();
self
}
/// Set the default compression to use for documents adhering to this schema.
pub fn doc_compress(mut self, doc_compress: Compress) -> Self {
self.inner.doc_compress = doc_compress;
self
}
/// Add a new entry type to the schema, where `entry` is the key for the entry, `validator`
/// will be used to validate each entry, and `compress` optionally overrides the default
/// compression with a specific compression setting.
pub fn entry_add(
mut self,
entry: &str,
validator: Validator,
compress: Option<Compress>,
) -> Self {
let compress = compress.unwrap_or_default();
self.inner.entries.insert(
entry.to_owned(),
EntrySchema {
entry: validator,
compress,
},
);
self
}
/// Set the schema name. This is only used for documentation purposes.
pub fn name(mut self, name: &str) -> Self {
self.inner.name = name.to_owned();
self
}
/// Add a new stored type to the schema.
pub fn type_add(mut self, type_ref: &str, validator: Validator) -> Self {
self.inner.types.insert(type_ref.to_owned(), validator);
self
}
/// Look up a type that has already been stored.
pub fn type_get(&self, type_ref: &str) -> Option<&Validator> {
self.inner.types.get(type_ref)
}
/// Set the schema version. This is only used for documentation purposes.
pub fn version<T: Into<Integer>>(mut self, version: T) -> Self {
self.inner.version = version.into();
self
}
/// Set the maximum number of regexes allowed in a query.
pub fn regexes(mut self, max_regex: u8) -> Self {
self.inner.max_regex = max_regex;
self
}
/// Build the Schema, compiling the result into a Document
pub fn build(self) -> Result<Document> {
let doc = NewDocument::new(None, self.inner)?;
NoSchema::validate_new_doc(doc)
}
}
/// A Schema, which can be used to encode/decode a document or entry, while verifying its
/// contents.
///
/// Schema are decoded from a correctly formatted [`Document`] that describes the format of other
/// documents and their associated entries. They also include recommended compression settings for
/// documents & entries adhering to them, which may include compression dictionaries.
///
/// A schema must come from a Document. To create one directly, use the [`SchemaBuilder`], then
/// decode the resulting Document into a schema.
#[derive(Clone, Debug)]
pub struct Schema {
hash: Hash,
inner: InnerSchema,
}
impl Schema {
/// Attempt to create a schema from a given document. Fails if the document isn't a schema.
///
/// Warnings
/// --------
///
/// If working with external, untrusted schemas, it's advisable to use
/// [`Schema::from_doc_max_regex`] instead, as regular expressions are hands-down the easiest
/// way to exhaust memory in a system.
pub fn from_doc(doc: &Document) -> Result<Self> {
let inner = doc.deserialize()?;
let hash = doc.hash().clone();
Ok(Self { hash, inner })
}
/// Attempt to create a schema from a given document, first checking how many regular
/// expressions would be present in the schema and failing out if it's above the provided
/// limit.
///
/// For a rough guide of what to set `max_regex` to, know that every regex has an
/// approximate max memory size of 12 MiB, so a malicious schema can use up at least
/// `max_regex * 12 MiB` bytes off the heap.
pub fn from_doc_max_regex(doc: &Document, max_regex: u8) -> Result<Self> {
// Count up all the regular expressions that can be in a schema
let regex_check: ValueRef = doc.deserialize()?;
let mut regexes = crate::count_regexes(®ex_check["doc"]);
if let Some(map) = regex_check["types"].as_map() {
regexes += map
.values()
.fold(0, |acc, val| acc + crate::count_regexes(val));
}
if let Some(map) = regex_check["entries"].as_map() {
regexes += map
.values()
.fold(0, |acc, val| acc + crate::count_regexes(&val["entry"]));
}
if regexes > (max_regex as usize) {
return Err(Error::FailValidate(format!(
"Found {} regexes in Schema, only {} allowed",
regexes, max_regex
)));
}
let inner = doc.deserialize()?;
let hash = doc.hash().clone();
Ok(Self { hash, inner })
}
/// Get the hash of this schema.
pub fn hash(&self) -> &Hash {
&self.hash
}
/// Validate a [`NewDocument`], turning it into a [`Document`]. Fails if the document doesn't
/// use this schema, or if it doesn't meet this schema's requirements.
pub fn validate_new_doc(&self, doc: NewDocument) -> Result<Document> {
// Check that the document uses this schema
match doc.schema_hash() {
Some(hash) if hash == &self.hash => (),
actual => {
return Err(Error::SchemaMismatch {
actual: actual.cloned(),
expected: Some(self.hash.clone()),
})
}
}
// Validate the data
let parser = Parser::new(doc.data());
let (parser, _) = self.inner.doc.validate(&self.inner.types, parser, None)?;
parser.finish()?;
Ok(Document::from_new(doc))
}
/// Encode a [`Document`], returning the resulting Document's hash and fully encoded format.
/// Fails if the document doesn't use this schema.
pub fn encode_doc(&self, doc: Document) -> Result<(Hash, Vec<u8>)> {
// Check that the document uses this schema
match doc.schema_hash() {
Some(hash) if hash == &self.hash => (),
actual => {
return Err(Error::SchemaMismatch {
actual: actual.cloned(),
expected: Some(self.hash.clone()),
})
}
}
// Compress the document
let (hash, doc, compression) = doc.complete();
let doc = match compression {
None => compress_doc(doc, &self.inner.doc_compress),
Some(None) => doc,
Some(Some(level)) => compress_doc(
doc,
&Compress::General {
algorithm: 0,
level,
},
),
};
Ok((hash, doc))
}
fn check_schema(&self, doc: &[u8]) -> Result<()> {
// Check that the document uses this schema
let split = SplitDoc::split(doc)?;
if split.hash_raw.is_empty() {
return Err(Error::SchemaMismatch {
actual: None,
expected: Some(self.hash.clone()),
});
}
let schema = Hash::try_from(split.hash_raw)
.map_err(|_| Error::BadHeader("Unable to decode schema hash".into()))?;
if schema != self.hash {
Err(Error::SchemaMismatch {
actual: Some(schema),
expected: Some(self.hash.clone()),
})
} else {
Ok(())
}
}
/// Decode a document that uses this schema.
pub fn decode_doc(&self, doc: Vec<u8>) -> Result<Document> {
self.check_schema(&doc)?;
// Decompress
let doc = Document::new(decompress_doc(doc, &self.inner.doc_compress)?)?;
// Validate
let parser = Parser::new(doc.data());
let (parser, _) = self.inner.doc.validate(&self.inner.types, parser, None)?;
parser.finish()?;
Ok(doc)
}
/// Decode a Document, skipping any checks of the data. This should only be run when the raw
/// document has definitely been passed through validation before, i.e. if it is stored in a
/// local database after going through [`encode_doc`][Self::encode_doc].
pub fn trusted_decode_doc(&self, doc: Vec<u8>) -> Result<Document> {
self.check_schema(&doc)?;
// Decompress
let doc = Document::new(decompress_doc(doc, &Compress::None)?)?;
Ok(doc)
}
/// Validate a [`NewEntry`], turning it into a [`Entry`]. Fails if provided the wrong parent
/// document, the parent document doesn't use this schema, or the entry doesn't meet the schema
/// requirements. The resulting Entry is stored in a [`DataChecklist`] that must be iterated
/// over in order to finish validation.
pub fn validate_new_entry(&self, entry: NewEntry) -> Result<DataChecklist<Entry>> {
// Check that the entry's parent document uses this schema
if entry.schema_hash() != &self.hash {
return Err(Error::SchemaMismatch {
actual: Some(entry.schema_hash().clone()),
expected: Some(self.hash.clone()),
});
}
// Validate the data and generate a checklist of remaining documents to check
let parser = Parser::new(entry.data());
let entry_schema = self.inner.entries.get(entry.key()).ok_or_else(|| {
Error::FailValidate(format!("entry key \"{:?}\" is not in schema", entry.key()))
})?;
let checklist = Some(Checklist::new(&self.hash, &self.inner.types));
let (parser, checklist) =
entry_schema
.entry
.validate(&self.inner.types, parser, checklist)?;
parser.finish()?;
Ok(DataChecklist::from_checklist(
checklist.unwrap(),
Entry::from_new(entry),
))
}
/// Encode an [`Entry`], returning the resulting Entry's reference, its fully encoded format,
/// and a list of Hashes of the Documents it needs for validation.
/// Fails if provided the wrong parent document or the parent document doesn't use this schema.
pub fn encode_entry(&self, entry: Entry) -> Result<(EntryRef, Vec<u8>, Vec<Hash>)> {
// Check that the entry's parent document uses this schema
if entry.schema_hash() != &self.hash {
return Err(Error::SchemaMismatch {
actual: Some(entry.schema_hash().clone()),
expected: Some(self.hash.clone()),
});
}
// We re-run validation here just to collect the hashes of documents needed for validation
// (i.e. the documents that would need to be provided with this entry if it were
// transferred or stored)
//
// At some point, it's plausible this could be performed with a more minimal validation
// check.
let entry_schema = self.inner.entries.get(entry.key()).ok_or_else(|| {
Error::FailValidate(format!("entry key \"{:?}\" is not in schema", entry.key()))
})?;
let parser = Parser::new(entry.data());
let checklist = Some(Checklist::new(&self.hash, &self.inner.types));
let (parser, checklist) =
entry_schema
.entry
.validate(&self.inner.types, parser, checklist)?;
parser.finish()?;
let needed_docs: Vec<Hash> = checklist.unwrap().iter().map(|(hash, _)| hash).collect();
// Compress the entry
let (entry_ref, entry, compression) = entry.complete();
let entry = match compression {
None => compress_entry(entry, &entry_schema.compress),
Some(None) => entry,
Some(Some(level)) => compress_entry(
entry,
&Compress::General {
algorithm: 0,
level,
},
),
};
Ok((entry_ref, entry, needed_docs))
}
/// Decode an entry, given the key and parent Hash. Result is in a [`DataChecklist`] that must
/// be iterated over in order to finish verification and get the resulting Entry.
pub fn decode_entry(
&self,
entry: Vec<u8>,
key: &str,
parent: &Document,
) -> Result<DataChecklist<Entry>> {
// Check that the entry's parent document uses this schema
match parent.schema_hash() {
Some(hash) if hash == &self.hash => (),
actual => {
return Err(Error::SchemaMismatch {
actual: actual.cloned(),
expected: Some(self.hash.clone()),
})
}
}
// Find the entry
let entry_schema = self.inner.entries.get(key).ok_or_else(|| {
Error::FailValidate(format!("entry key \"{:?}\" is not in schema", key))
})?;
// Decompress
let entry = Entry::new(
decompress_entry(entry, &entry_schema.compress)?,
key,
parent,
)?;
// Validate
let parser = Parser::new(entry.data());
let checklist = Some(Checklist::new(&self.hash, &self.inner.types));
let (parser, checklist) =
entry_schema
.entry
.validate(&self.inner.types, parser, checklist)?;
parser.finish()?;
Ok(DataChecklist::from_checklist(checklist.unwrap(), entry))
}
/// Decode a Entry, skipping most checks of the data. This should only be run when the raw
/// entry has definitely been passed through validation before, i.e. if it is stored in a
/// local database after going through [`encode_entry`][Self::encode_entry].
pub fn trusted_decode_entry(
&self,
entry: Vec<u8>,
key: &str,
parent: &Document,
entry_hash: &Hash,
) -> Result<Entry> {
// Check that the entry's parent document uses this schema
match parent.schema_hash() {
Some(hash) if hash == &self.hash => (),
actual => {
return Err(Error::SchemaMismatch {
actual: actual.cloned(),
expected: Some(self.hash.clone()),
})
}
}
// Find the entry
let entry_schema = self.inner.entries.get(key).ok_or_else(|| {
Error::FailValidate(format!("entry key \"{:?}\" is not in schema", key))
})?;
// Decompress
let entry = Entry::trusted_new(
decompress_entry(entry, &entry_schema.compress)?,
key,
parent,
entry_hash,
)?;
Ok(entry)
}
/// Encode a query into a byte sequence. Fails if the query is against an
/// entry key that isn't in the schema, or if the query isn't a valid one
/// according to the various query permissions in the schema's validators.
///
/// Queries are encoded like fog-pack documents, but without the header
/// containing compression and schema info.
pub fn encode_query(&self, query: NewQuery) -> Result<Vec<u8>> {
let key = query.key();
let entry_schema = self.inner.entries.get(key).ok_or_else(|| {
Error::FailValidate(format!("entry key \"{:?}\" is not in schema", key))
})?;
if entry_schema
.entry
.query_check(&self.inner.types, query.validator())
{
query.complete(self.inner.max_regex)
} else {
Err(Error::FailValidate("Query is not allowed by schema".into()))
}
}
/// Attempt to decode a query from a byte sequence. Fails if the byte
/// sequence isn't a valid encoding, if the query is against an entry key
/// that isn't in the schema, or if the query isn't a valid one according to
/// the various query permissions in the schema's validators.
///
/// Queries are encoded like fog-pack documents, but without the header
/// containing compression and schema info.
pub fn decode_query(&self, query: Vec<u8>) -> Result<Query> {
let query = Query::new(query, self.inner.max_regex)?;
let key = query.key();
let entry_schema = self.inner.entries.get(key).ok_or_else(|| {
Error::FailValidate(format!("entry key \"{:?}\" is not in schema", key))
})?;
if entry_schema
.entry
.query_check(&self.inner.types, query.validator())
{
Ok(query)
} else {
Err(Error::FailValidate("Query is not allowed by schema".into()))
}
}
}