Crate rspamd_base32

Crate rspamd_base32 

Source
Expand description

§Rspamd Base32 encode/decode library

This is a conversion module from and to zbase32 encoding. It also supports RFC 4648 and Bech32 alphabets.

The main purpose of zbase32 is to provide human readable encoding that is more efficient than hex encoding. zbase32 utilizes up to len * 5 / 8 of space for encoded date and contains no padding (and hence no error control, like base64). However, it seems to be much readable for a human when an encoding does not contain padding.

§Disclaimers

This module is intended to be compatible with Rspamd base32 encoding, so it has bug-to-bug compatibility with Rspamd C implementation including:

  • Zbase32 encodes data in reversed octets order (due to the initial bug in Rspamd and lack of test vectors)
  • RFC 4648 encoding does not include padding (because padding as defined in RFC for base32 is just ugly)

§Example

use rspamd_base32::{encode, decode};

fn main() {
 let a = b"hello world";
 let b = "em3ags7py376g3tprd";

 assert_eq!(encode(a), b);
 assert_eq!(a, &decode(b).unwrap()[..]);
}

Re-exports§

pub use crate::encode::encode;
pub use crate::encode::encode_alphabet;
pub use crate::encode::encode_alphabet_slice;
pub use crate::decode::decode;
pub use crate::decode::decode_alphabet;
pub use crate::decode::decode_alphabet_vec;

Modules§

alphabet
Provides Alphabet used for Base32 encoding and decoding
decode
Base32 decoding routines
encode
Base32 encoding routines