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

/*
 * Copyright 2020 Fluence Labs Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/// Describes manifest of a Wasm module in the Fluence network.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ModuleManifest {
    pub authors: String,
    pub version: semver::Version,
    pub description: String,
    pub repository: String,
    pub build_time: chrono::DateTime<chrono::FixedOffset>,
}

use super::ManifestError;

use std::convert::TryFrom;
use std::str::FromStr;

type Result<T> = std::result::Result<T, ManifestError>;

impl TryFrom<&[u8]> for ModuleManifest {
    type Error = ManifestError;

    #[rustfmt::skip]
    fn try_from(value: &[u8]) -> Result<Self> {
        let (authors, next_offset) = try_extract_field_as_string(value, 0, "authors")?;
        let (version, next_offset) = try_extract_field_as_version(value, next_offset, "version")?;
        let (description, next_offset) = try_extract_field_as_string(value, next_offset, "description")?;
        let (repository, next_offset) = try_extract_field_as_string(value, next_offset, "repository")?;
        let (build_time, next_offset) = try_extract_field_as_string(value, next_offset, "build time")?;

        if next_offset != value.len() {
            return Err(ManifestError::ManifestRemainderNotEmpty)
        }

        let build_time = chrono::DateTime::parse_from_rfc3339(&build_time)?;

        let manifest = ModuleManifest {
            authors,
            version,
            description,
            repository,
            build_time
        };

        Ok(manifest)
    }
}

fn try_extract_field_as_string(
    raw_manifest: &[u8],
    offset: usize,
    field_name: &'static str,
) -> Result<(String, usize)> {
    let raw_manifest = &raw_manifest[offset..];
    let (field_as_bytes, read_len) = try_extract_prefixed_field(raw_manifest, field_name)?;
    let field_as_string = try_to_str(field_as_bytes, field_name)?.to_string();

    Ok((field_as_string, offset + read_len))
}

fn try_extract_field_as_version(
    raw_manifest: &[u8],
    offset: usize,
    field_name: &'static str,
) -> Result<(semver::Version, usize)> {
    let raw_manifest = &raw_manifest[offset..];
    let (field_as_bytes, read_len) = try_extract_prefixed_field(raw_manifest, field_name)?;
    let field_as_str = try_to_str(field_as_bytes, field_name)?;
    let version = semver::Version::from_str(field_as_str)?;

    Ok((version, offset + read_len))
}

const PREFIX_SIZE: usize = std::mem::size_of::<u64>();

fn try_extract_prefixed_field<'a>(
    array: &'a [u8],
    field_name: &'static str,
) -> Result<(&'a [u8], usize)> {
    let field_len = try_extract_field_len(array, field_name)?;
    let field = try_extract_field(array, field_len, field_name)?;

    let read_size = PREFIX_SIZE + field.len();
    Ok((field, read_size))
}

fn try_extract_field_len(array: &[u8], field_name: &'static str) -> Result<usize> {
    if array.len() < PREFIX_SIZE {
        return Err(ManifestError::NotEnoughBytesForPrefix(field_name));
    }

    let mut field_len = [0u8; PREFIX_SIZE];
    field_len.copy_from_slice(&array[0..PREFIX_SIZE]);

    let field_len = u64::from_le_bytes(field_len);
    // TODO: Until we use Wasm32 and compiles our node to x86_64, converting to usize is sound
    if field_len.checked_add(PREFIX_SIZE as u64).is_none()
        || usize::try_from(field_len + PREFIX_SIZE as u64).is_err()
    {
        return Err(ManifestError::TooBigFieldSize(field_name, field_len));
    }

    // it's safe to convert it to usize because it's been checked
    Ok(field_len as usize)
}

fn try_extract_field<'a>(
    array: &'a [u8],
    field_len: usize,
    field_name: &'static str,
) -> Result<&'a [u8]> {
    if array.len() < PREFIX_SIZE + field_len {
        return Err(ManifestError::NotEnoughBytesForField(field_name, field_len));
    }

    let field = &array[PREFIX_SIZE..PREFIX_SIZE + field_len];
    Ok(field)
}

fn try_to_str<'v>(value: &'v [u8], field_name: &'static str) -> Result<&'v str> {
    match std::str::from_utf8(value) {
        Ok(s) => Ok(s),
        Err(e) => Err(ManifestError::FieldNotValidUtf8(field_name, e)),
    }
}

use std::fmt;

impl fmt::Display for ModuleManifest {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "authors:     {}", self.authors)?;
        writeln!(f, "version:     {}", self.version)?;
        writeln!(f, "description: {}", self.description)?;
        writeln!(f, "repository:  {}", self.repository)?;
        write!(f, "build time:  {} UTC", self.build_time)
    }
}