Struct brane_shr::fs::DownloadSecurity

pub struct DownloadSecurity<'c> {
    pub checksum: Option<&'c [u8]>,
    pub https: bool,
}

Defines things to do to assert a downloaded file is secure and what we expect.

Fields

checksum: Option<&'c [u8]>

If not None, then it defined the checksum that the file should have.

https: bool

If true, then the file can only be downloaded over HTTPS.

Implementations

impl<'c> DownloadSecurity<'c>

pub fn all(checkum: &'c [u8]) -> Self

Constructor for the DownloadSecurity that enables with all security measures enabled.

This will provide you with the most security, but is also the slowest method (since it does both encryption and checksum computation).

Usually, it sufficies to only use a checksum (DownloadSecurity::checksum()) if you know what the file looks like a-priori.

Arguments

• checksum: The checksum that we want the file to have. If you are unsure, give a garbage checksum, then run the function once and check what the file had (after making sure the download went correctly, of course).

Returns

A new DownloadSecurity instance that will make your downloaded file so secure you can use it to store a country’s defecit (not legal advice).

pub fn checksum(checkum: &'c [u8]) -> Self

Constructor for the DownloadSecurity that enables checksum verification only.

Using this method is considered secure, since it guarantees that the downloaded file is what we expect. It is thus safe to use if you don’t trust either the network or the remote praty.

Note, however, that this method only works if you know a-priori what the downloaded file should look like. If not, you must use another security method (e.g., DownloadSecurity::https()).

Arguments

• checksum: The checksum that we want the file to have. If you are unsure, give a garbage checksum, then run the function once and check what the file had (after making sure the download went correctly, of course).

Returns

A new DownloadSecurity instance that will make sure your file has the given checksum before returning.

pub fn https() -> Self

Constructor for the DownloadSecurity that forces downloads to go over HTTPS.

You should only use this method if you trust the remote party. However, if you do, then it guarantees that there was no man-in-the-middle changing the downloaded file.

Returns

A new DownloadSecurity instance that will make sure your file if downloaded over HTTPS only.

pub fn none() -> Self

Constructor for the DownloadSecurity that disabled all security measures.

For obvious reasons, this security is not recommended unless you trust both the network and the remote party.

Returns

A new DownloadSecurity instance that will require no additional security measures on the downloaded file.

Trait Implementations

impl<'c> Clone for DownloadSecurity<'c>

fn clone(&self) -> DownloadSecurity<'c>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'c> Debug for DownloadSecurity<'c>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'c> Display for DownloadSecurity<'c>

fn fmt(&self, f: &mut Formatter<'_>) -> FResult

Formats the value using the given formatter.