mcvm 0.25.0

A fast, extensible, and powerful Minecraft launcher
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
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

use std::fs::File;
use std::io::{BufReader, Read};
use std::path::Path;

use anyhow::Context;
use mcvm_shared::pkg::PackageAddonOptionalHashes;
use sha2::{Digest, Sha256, Sha512};

/// Length in bytes of a SHA-256 hash
pub const HASH_SHA256_RESULT_LENGTH: usize = 32;
/// Length in bytes of a SHA-512 hash
pub const HASH_SHA512_RESULT_LENGTH: usize = 64;

/// Get a hash string as a hex
pub fn get_hash_str_as_hex(hash: &str) -> anyhow::Result<Vec<u8>> {
	Ok(hex::decode(hash)?)
}

/// The different hash types used by addons
#[derive(Copy, Clone)]
pub enum AddonHashType {
	/// SHA-256 hash
	SHA256,
	/// SHA-512 hash
	SHA512,
}

/// Best hash value and hash type from the get_best_hash function
pub struct BestHashResult(String, AddonHashType);

/// Get the best hash from a set of addon hashes
pub fn get_best_hash(hashes: &PackageAddonOptionalHashes) -> Option<BestHashResult> {
	let mut best = None;

	if let Some(hash) = &hashes.sha256 {
		best = Some(BestHashResult(hash.clone(), AddonHashType::SHA256));
	}

	if let Some(hash) = &hashes.sha512 {
		best = Some(BestHashResult(hash.clone(), AddonHashType::SHA512));
	}

	best
}

/// Get a reader's hash based on the get_best_hash function
pub fn get_reader_best_hash<R: Read>(
	reader: R,
	hash_type: AddonHashType,
) -> anyhow::Result<Vec<u8>> {
	match hash_type {
		AddonHashType::SHA256 => digest_reader::<Sha256, _>(reader),
		AddonHashType::SHA512 => digest_reader::<Sha512, _>(reader),
	}
}

/// Check the hash of a file based on the get_best_hash function. Returns true if the hash matches
pub fn hash_file_with_best_hash(path: &Path, result: BestHashResult) -> anyhow::Result<bool> {
	let BestHashResult(expected_hash, hash_type) = result;

	let file = File::open(path).context("Failed to open file for checksum")?;
	let mut file = BufReader::new(file);

	let actual_hash =
		get_reader_best_hash(&mut file, hash_type).context("Failed to compute file hash")?;

	let matches = actual_hash
		== get_hash_str_as_hex(&expected_hash).context("Failed to parse provided hash")?;

	Ok(matches)
}

/// Digest a reader into a hasher
pub fn digest_reader<D: Digest, R: Read>(mut reader: R) -> anyhow::Result<Vec<u8>> {
	let mut digest = D::new();
	let mut buf = [0; 1024];

	loop {
		let count = reader.read(&mut buf)?;
		if count == 0 {
			break;
		}
		digest.update(&buf[..count]);
	}

	Ok(digest.finalize().to_vec())
}

#[cfg(test)]
mod tests {
	use std::io::Cursor;

	use sha2::Sha512;

	use super::*;

	#[test]
	fn test_digest_reader() {
		let text = "Hello";
		let cursor = Cursor::new(text);
		let hash = digest_reader::<Sha512, _>(cursor).unwrap();
		assert_eq!(
			hash,
			hex::decode("3615f80c9d293ed7402687f94b22d58e529b8cc7916f8fac7fddf7fbd5af4cf777d3d795a7a00a16bf7e7f3fb9561ee9baae480da9fe7a18769e71886b03f315")
				.unwrap()
		);
	}
}