gpg-inspector-lib 0.8.0

A library for parsing and inspecting OpenPGP (GPG) packets according to RFC 4880 and RFC 9580
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

//! User ID packet parsing.
//!
//! This module parses User ID packets (tag 13), which contain a UTF-8
//! string identifying the key owner. The typical format is
//! "Name (Comment) <email@example.com>".

use crate::error::Result;
use crate::packet::Field;
use crate::stream::ByteStream;

/// A parsed User ID packet.
///
/// Contains a single UTF-8 string identifying the key owner.
#[derive(Debug, Clone)]
pub struct UserIdPacket {
    /// The user ID string (typically "Name \<email\>").
    pub user_id: String,
}

/// Parses a User ID packet body.
pub fn parse_user_id(
    stream: &mut ByteStream,
    fields: &mut Vec<Field>,
    offset: usize,
) -> Result<UserIdPacket> {
    let start = offset + stream.pos();
    let user_id = stream.utf8(stream.remaining())?;
    let end = offset + stream.pos();

    fields.push(Field::field("User ID", user_id.clone(), (start, end)));

    Ok(UserIdPacket { user_id })
}