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 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
use core::fmt;
use serde::{de, ser};
/// A bit string.
///
/// Rewrite based on [this implementation](https://melvinw.github.io/rust-asn1/asn1/struct.BitString.html) by Melvin Walls Jr.
/// licensed with
///
/// > The MIT License (MIT)
/// >
/// > Copyright (c) 2016 Melvin Walls Jr.
/// >
/// > Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
/// >
/// > The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
/// >
/// > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
///
/// # Examples
///
/// ```
/// use picky_asn1::bit_string::BitString;
///
/// let mut b = BitString::with_len(60);
///
/// b.set(0, true);
/// assert_eq!(b.is_set(0), true);
///
/// b.set(59, true);
/// assert_eq!(b.is_set(59), true);
///
/// // because len is 60, attempts at setting anything greater than 59 won't change anything
/// b.set(63, true);
/// assert_eq!(b.is_set(63), false);
/// ```
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Clone)]
pub struct BitString {
data: Vec<u8>,
}
impl BitString {
/// Returns inner bytes slice
pub fn as_bytes(&self) -> &[u8] {
&self.data
}
fn h_number_of_unused_bits(data_size: usize, num_bits: usize) -> u8 {
(data_size * 8 - num_bits) as u8
}
/// Construct a `BitString` of length `n` with all bits set to 0.
pub fn with_len(num_bits: usize) -> BitString {
let data_size = num_bits / 8 + if num_bits % 8 == 0 { 0 } else { 1 };
let mut data = vec![0x00u8; data_size + 1];
data[0] = Self::h_number_of_unused_bits(data_size, num_bits);
BitString { data }
}
/// Construct a `BitString` of length `n` with initial values contained in `data`.
///
/// # Examples
///
/// ```
/// use picky_asn1::bit_string::BitString;
///
/// let v: Vec<u8> = vec![0x00, 0x02];
/// let b = BitString::with_bytes_and_len(v, 15);
/// assert_eq!(b.is_set(0), false);
/// assert_eq!(b.is_set(14), true);
///
/// // because len is 15, everything greater than 14 will returns false
/// assert_eq!(b.is_set(15), false);
/// assert_eq!(b.is_set(938), false);
/// ```
pub fn with_bytes_and_len<V>(data: V, num_bits: usize) -> BitString
where
V: Into<Vec<u8>>,
{
let mut data = data.into();
let number_of_unused = Self::h_number_of_unused_bits(data.len(), num_bits);
data.insert(0, number_of_unused);
BitString { data }
}
/// Construct a `BitString` from initial values contained in `data`.
/// Length is inferred fromthe size of `data`.
///
/// # Examples
///
/// ```
/// use picky_asn1::bit_string::BitString;
///
/// let v: Vec<u8> = vec![0x00, 0x02];
/// let b = BitString::with_bytes(v);
/// assert_eq!(b.is_set(0), false);
/// assert_eq!(b.is_set(14), true);
/// ```
pub fn with_bytes<V>(data: V) -> BitString
where
V: Into<Vec<u8>>,
{
let mut data = data.into();
data.insert(0, 0); // no unused bits
BitString { data }
}
/// Get the number of available bits in the `BitString`
pub fn get_num_bits(&self) -> usize {
(self.data.len() - 1) * 8 - self.data[0] as usize
}
/// Set the length of a `BitString` with each additional slot filled with 0.
///
/// # Examples
///
/// ```
/// use picky_asn1::bit_string::BitString;
///
/// let v: Vec<u8> = vec![0x01, 0x01];
/// let mut b = BitString::with_bytes_and_len(v, 16);
/// assert_eq!(b.is_set(7), true);
/// assert_eq!(b.is_set(15), true);
///
/// b.set_num_bits(8);
/// assert_eq!(b.is_set(7), true);
/// b.set(15, true); // attempts to set a value out of the bounds are ignored
/// assert_eq!(b.is_set(15), false);
///
/// b.set_num_bits(16);
/// assert_eq!(b.is_set(7), true);
/// assert_eq!(b.is_set(15), false);
/// b.set(15, true);
/// assert_eq!(b.is_set(15), true);
/// ```
pub fn set_num_bits(&mut self, num_bits: usize) {
let new_size = num_bits / 8 + if num_bits % 8 == 0 { 0 } else { 1 };
self.data[0] = Self::h_number_of_unused_bits(new_size, num_bits);
self.data.resize(new_size + 1, 0);
}
/// Check if bit `i` is set.
///
/// # Examples
///
/// ```
/// use picky_asn1::bit_string::BitString;
///
/// let mut b = BitString::with_len(10);
/// assert_eq!(b.is_set(7), false);
/// b.set(7, true);
/// assert_eq!(b.is_set(7), true);
/// ```
pub fn is_set(&self, i: usize) -> bool {
if i > self.get_num_bits() {
return false;
}
let bucket = i / 8;
let pos = i - bucket * 8;
let mask = (1 << (7 - pos)) as u8;
self.data[bucket + 1] & mask != 0
}
/// Set bit `i` to `val`.
pub fn set(&mut self, i: usize, val: bool) {
if i > self.get_num_bits() {
return;
}
let bucket = i / 8;
let pos = i - bucket * 8;
let mask = (1 << (7 - pos)) as u8;
if val {
self.data[bucket + 1] |= mask;
} else {
self.data[bucket + 1] &= !mask;
}
}
pub fn get_num_unused_bits(&self) -> u8 {
self.data[0]
}
pub fn get_num_buckets(&self) -> usize {
self.data.len() - 1
}
pub fn get_bucket(&self, i: usize) -> u8 {
self.data[i + 1]
}
pub fn get_bucket_mut(&mut self, i: usize) -> &mut u8 {
&mut self.data[i + 1]
}
pub fn set_bucket(&mut self, i: usize, value: u8) {
self.data[i + 1] = value
}
/// Returns an immutabe view on the payload.
///
/// # Examples
///
/// ```
/// use picky_asn1::bit_string::BitString;
///
/// let v: Vec<u8> = vec![0x01, 0x00];
/// let mut b = BitString::with_bytes_and_len(v, 15);
/// b.set(14, true);
/// let payload = b.payload_view();
/// assert_eq!(payload, &[0x01, 0x02]);
/// ```
pub fn payload_view(&self) -> &[u8] {
&self.data[1..]
}
/// Returns a mutabe view on the payload.
///
/// # Examples
///
/// ```
/// use picky_asn1::bit_string::BitString;
///
/// let v: Vec<u8> = vec![0x01, 0x00];
/// let mut b = BitString::with_bytes_and_len(v, 15);
/// b.set(14, true);
/// let payload = b.payload_view_mut();
/// payload[0] = 0x20;
/// assert_eq!(payload, &[0x20, 0x02]);
/// ```
pub fn payload_view_mut(&mut self) -> &mut [u8] {
&mut self.data[1..]
}
}
impl fmt::Debug for BitString {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "0x")?;
self.data.iter().try_for_each(|byte| write!(f, "{byte:02X}"))?;
Ok(())
}
}
impl From<BitString> for Vec<u8> {
/// Strips 'unused bits count' byte and returns payload.
///
/// # Examples
///
/// ```
/// use picky_asn1::bit_string::BitString;
///
/// let v: Vec<u8> = vec![0x01, 0x00];
/// let mut b = BitString::with_bytes_and_len(v, 15);
/// b.set(14, true);
/// let payload: Vec<u8> = b.into();
/// assert_eq!(payload, vec![0x01, 0x02]);
/// ```
fn from(mut bs: BitString) -> Self {
bs.data.drain(1..).collect()
}
}
impl<'de> de::Deserialize<'de> for BitString {
fn deserialize<D>(deserializer: D) -> Result<BitString, D::Error>
where
D: de::Deserializer<'de>,
{
struct Visitor;
impl<'de> de::Visitor<'de> for Visitor {
type Value = BitString;
fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
formatter.write_str("a valid buffer representing a bit string")
}
fn visit_bytes<E>(self, v: &[u8]) -> Result<Self::Value, E>
where
E: de::Error,
{
self.visit_byte_buf(v.to_vec())
}
fn visit_byte_buf<E>(self, v: Vec<u8>) -> Result<Self::Value, E>
where
E: de::Error,
{
Ok(BitString { data: v })
}
}
deserializer.deserialize_byte_buf(Visitor)
}
}
impl ser::Serialize for BitString {
fn serialize<S>(&self, serializer: S) -> Result<<S as ser::Serializer>::Ok, <S as ser::Serializer>::Error>
where
S: ser::Serializer,
{
serializer.serialize_bytes(&self.data)
}
}
impl Default for BitString {
fn default() -> Self {
BitString::with_len(0)
}
}