wasefire 0.8.1

High-level Wasefire applet API
Documentation 
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

// Copyright 2023 Google LLC
//
// 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.

//! Provides API for to update the platform.

use wasefire_applet_api::platform::update as api;

use crate::{Error, convert_unit};

/// Starts a platform update process.
///
/// During a dry-run, any mutable operation is skipped and only checks are performed.
pub fn initialize(dry_run: bool) -> Result<(), Error> {
    let params = api::initialize::Params { dry_run: dry_run as usize };
    convert_unit(unsafe { api::initialize(params) })
}

/// Processes the next chunk of a platform update.
pub fn process(chunk: &[u8]) -> Result<(), Error> {
    let params = api::process::Params { ptr: chunk.as_ptr(), len: chunk.len() };
    convert_unit(unsafe { api::process(params) })
}

/// Finalizes a platform update process.
///
/// This function will reboot when the update is successful and thus only returns in case of errors
/// or in dry-run mode.
pub fn finalize() -> Result<(), Error> {
    convert_unit(unsafe { api::finalize() })
}