bhmdoc 0.6.1

TBTL's library for handling mDL/mdoc specification.
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

// Copyright (C) 2020-2026  The Blockhouse Technology Limited (TBTL).
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or (at your
// option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public
// License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

use base64::{engine::general_purpose::URL_SAFE_NO_PAD, Engine as _};

/// Returns the `base64url`-encoded string **without padding** of the given
/// `payload`.
pub fn base64_url_encode<T: AsRef<[u8]>>(payload: T) -> String {
    URL_SAFE_NO_PAD.encode(payload)
}

/// Decodes the given `payload` as the `base64url`-encoded string **without
/// padding** into bytes.
pub fn base64_url_decode<T: AsRef<[u8]>>(payload: T) -> Result<Vec<u8>, base64::DecodeError> {
    URL_SAFE_NO_PAD.decode(payload)
}

#[cfg(test)]
mod tests {
    use assert_matches::assert_matches;

    use super::*;

    const TEST_CASES: [(&str, &str); 4] = [
        ("Hello, World!", "SGVsbG8sIFdvcmxkIQ"),
        ("", ""),
        ("Rust! 🚀", "UnVzdCEg8J-agA"),
        ("no padding here", "bm8gcGFkZGluZyBoZXJl"),
    ];

    #[test]
    fn test_base64_url_encode() {
        for (input, expected) in TEST_CASES {
            let result = base64_url_encode(input);
            assert_eq!(result, expected, "{input}");
        }
    }

    #[test]
    fn test_base64_url_encode_binary_data() {
        let input = [0xDE, 0xAD, 0xBE, 0xEF];
        let expected = "3q2-7w";
        let result = base64_url_encode(input);
        assert_eq!(result, expected);
    }

    #[test]
    fn test_base64_url_decode() {
        for (expected, input) in TEST_CASES {
            let result = base64_url_decode(input).unwrap();
            assert_eq!(result, expected.as_bytes(), "{input}");
        }
    }

    #[test]
    fn test_base64_url_decode_binary_data() {
        let input = "3q2-7w";
        let expected = [0xDE, 0xAD, 0xBE, 0xEF];
        let result = base64_url_decode(input).unwrap();
        assert_eq!(result, expected);
    }

    #[test]
    fn test_base64_url_decode_padded_input() {
        let input = "SGVsbG8sIFdvcmxkIQ==";
        let err = base64_url_decode(input).unwrap_err();
        assert_matches!(err, base64::DecodeError::InvalidPadding);
    }

    #[test]
    fn test_base64_url_decode_invalid_input() {
        let input = "inv@lid";
        let err = base64_url_decode(input).unwrap_err();
        assert_matches!(err, base64::DecodeError::InvalidByte(3, b'@'));
    }
}