der/asn1/
ia5_string.rs

1//! ASN.1 `IA5String` support.
2
3use crate::{
4    asn1::AnyRef, ord::OrdIsValueOrd, ByteSlice, DecodeValue, EncodeValue, Error, FixedTag, Header,
5    Length, Reader, Result, StrSlice, Tag, Writer,
6};
7use core::{fmt, ops::Deref, str};
8
9/// ASN.1 `IA5String` type.
10///
11/// Supports the [International Alphabet No. 5 (IA5)] character encoding, i.e.
12/// the lower 128 characters of the ASCII alphabet. (Note: IA5 is now
13/// technically known as the International Reference Alphabet or IRA as
14/// specified in the ITU-T's T.50 recommendation).
15///
16/// For UTF-8, use [`Utf8StringRef`][`crate::asn1::Utf8StringRef`].
17///
18/// This is a zero-copy reference type which borrows from the input data.
19///
20/// [International Alphabet No. 5 (IA5)]: https://en.wikipedia.org/wiki/T.50_%28standard%29
21#[derive(Copy, Clone, Eq, PartialEq, PartialOrd, Ord)]
22pub struct Ia5StringRef<'a> {
23    /// Inner value
24    inner: StrSlice<'a>,
25}
26
27impl<'a> Ia5StringRef<'a> {
28    /// Create a new `IA5String`.
29    pub fn new<T>(input: &'a T) -> Result<Self>
30    where
31        T: AsRef<[u8]> + ?Sized,
32    {
33        let input = input.as_ref();
34
35        // Validate all characters are within IA5String's allowed set
36        if input.iter().any(|&c| c > 0x7F) {
37            return Err(Self::TAG.value_error());
38        }
39
40        StrSlice::from_bytes(input)
41            .map(|inner| Self { inner })
42            .map_err(|_| Self::TAG.value_error())
43    }
44}
45
46impl<'a> Deref for Ia5StringRef<'a> {
47    type Target = StrSlice<'a>;
48
49    fn deref(&self) -> &Self::Target {
50        &self.inner
51    }
52}
53
54impl AsRef<str> for Ia5StringRef<'_> {
55    fn as_ref(&self) -> &str {
56        self.as_str()
57    }
58}
59
60impl AsRef<[u8]> for Ia5StringRef<'_> {
61    fn as_ref(&self) -> &[u8] {
62        self.as_bytes()
63    }
64}
65
66impl<'a> DecodeValue<'a> for Ia5StringRef<'a> {
67    fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
68        Self::new(ByteSlice::decode_value(reader, header)?.as_slice())
69    }
70}
71
72impl EncodeValue for Ia5StringRef<'_> {
73    fn value_len(&self) -> Result<Length> {
74        self.inner.value_len()
75    }
76
77    fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
78        self.inner.encode_value(writer)
79    }
80}
81
82impl<'a> FixedTag for Ia5StringRef<'a> {
83    const TAG: Tag = Tag::Ia5String;
84}
85
86impl OrdIsValueOrd for Ia5StringRef<'_> {}
87
88impl<'a> From<&Ia5StringRef<'a>> for Ia5StringRef<'a> {
89    fn from(value: &Ia5StringRef<'a>) -> Ia5StringRef<'a> {
90        *value
91    }
92}
93
94impl<'a> TryFrom<AnyRef<'a>> for Ia5StringRef<'a> {
95    type Error = Error;
96
97    fn try_from(any: AnyRef<'a>) -> Result<Ia5StringRef<'a>> {
98        any.decode_into()
99    }
100}
101
102impl<'a> From<Ia5StringRef<'a>> for AnyRef<'a> {
103    fn from(printable_string: Ia5StringRef<'a>) -> AnyRef<'a> {
104        AnyRef::from_tag_and_value(Tag::Ia5String, printable_string.inner.into())
105    }
106}
107
108impl<'a> fmt::Display for Ia5StringRef<'a> {
109    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
110        f.write_str(self.as_str())
111    }
112}
113
114impl<'a> fmt::Debug for Ia5StringRef<'a> {
115    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
116        write!(f, "Ia5String({:?})", self.as_str())
117    }
118}
119
120#[cfg(test)]
121mod tests {
122    use super::Ia5StringRef;
123    use crate::Decode;
124    use hex_literal::hex;
125
126    #[test]
127    fn parse_bytes() {
128        let example_bytes = hex!("16 0d 74 65 73 74 31 40 72 73 61 2e 63 6f 6d");
129        let printable_string = Ia5StringRef::from_der(&example_bytes).unwrap();
130        assert_eq!(printable_string.as_str(), "test1@rsa.com");
131    }
132}