solana_program/
sanitize.rs

1//! A trait for sanitizing values and members of over the wire messages.
2
3use thiserror::Error;
4
5#[derive(PartialEq, Debug, Error, Eq, Clone)]
6pub enum SanitizeError {
7    #[error("index out of bounds")]
8    IndexOutOfBounds,
9    #[error("value out of bounds")]
10    ValueOutOfBounds,
11    #[error("invalid value")]
12    InvalidValue,
13}
14
15/// A trait for sanitizing values and members of over-the-wire messages.
16///
17/// Implementation should recursively descend through the data structure and
18/// sanitize all struct members and enum clauses. Sanitize excludes signature-
19/// verification checks, those are handled by another pass. Sanitize checks
20/// should include but are not limited to:
21///
22/// - All index values are in range.
23/// - All values are within their static max/min bounds.
24pub trait Sanitize {
25    fn sanitize(&self) -> Result<(), SanitizeError> {
26        Ok(())
27    }
28}
29
30impl<T: Sanitize> Sanitize for Vec<T> {
31    fn sanitize(&self) -> Result<(), SanitizeError> {
32        for x in self.iter() {
33            x.sanitize()?;
34        }
35        Ok(())
36    }
37}
solana_program/sanitize.rs

solana_program/
sanitize.rs
