Skip to main content

SnmpV3Message

Struct SnmpV3Message 

Source
pub struct SnmpV3Message { /* private fields */ }
Expand description

SNMPv3 top-level message wrapper fields.

This models the RFC 3412 message framing only. Security-model processing, USM credentials, encryption, authentication, timeliness, and scoped-PDU interpretation belong to later packet slices or generated tools.

Implementations§

Source§

impl SnmpV3Message

Source

pub fn new( msg_id: i64, max_size: i64, flags: impl Into<Vec<u8>>, security_model: i64, security_parameters: impl Into<Vec<u8>>, scoped_data: impl Into<Vec<u8>>, ) -> Self

Build an SNMPv3 message wrapper with raw security/scoped-data bytes.

Source

pub fn new_plaintext( msg_id: i64, max_size: i64, flags: impl Into<Vec<u8>>, security_model: i64, security_parameters: impl Into<Vec<u8>>, scoped_pdu: SnmpScopedPdu, ) -> Result<Self>

Build an SNMPv3 message wrapper carrying plaintext scoped-PDU data.

Source

pub fn new_usm( msg_id: i64, max_size: i64, flags: impl Into<Vec<u8>>, usm: SnmpUsmSecurityParameters, scoped_data: impl Into<Vec<u8>>, ) -> Result<Self>

Build an SNMPv3 message wrapper carrying USM security parameters.

Source

pub fn new_encrypted_usm( msg_id: i64, max_size: i64, flags: impl Into<Vec<u8>>, usm: SnmpUsmSecurityParameters, encrypted_pdu: impl Into<Vec<u8>>, ) -> Result<Self>

Build an SNMPv3 USM message carrying opaque encrypted scoped data.

Source

pub fn new_plaintext_report( msg_id: i64, max_size: i64, flags: impl Into<Vec<u8>>, security_model: i64, security_parameters: impl Into<Vec<u8>>, context_engine_id: impl Into<Vec<u8>>, context_name: impl Into<Vec<u8>>, request_id: i64, varbinds: SnmpVarBindList, ) -> Result<Self>

Build an SNMPv3 message with a plaintext Report-PDU.

Source

pub fn new_usm_report( msg_id: i64, max_size: i64, flags: impl Into<Vec<u8>>, usm: SnmpUsmSecurityParameters, context_engine_id: impl Into<Vec<u8>>, context_name: impl Into<Vec<u8>>, request_id: i64, varbinds: SnmpVarBindList, ) -> Result<Self>

Build an SNMPv3 USM message with a plaintext Report-PDU.

Source

pub const fn version(&self) -> SnmpVersion

Message wrapper version.

Source

pub const fn version_value(&self) -> i64

Raw message wrapper version INTEGER.

Source

pub const fn global_data(&self) -> &SnmpV3GlobalData

RFC 3412 HeaderData global message fields.

Source

pub const fn msg_id(&self) -> i64

RFC 3412 msgID INTEGER value.

Source

pub const fn max_size(&self) -> i64

RFC 3412 msgMaxSize INTEGER value.

Source

pub fn flags(&self) -> &[u8]

Raw RFC 3412 msgFlags OCTET STRING bytes.

Source

pub fn flags_value(&self) -> SnmpV3Flags

Typed view of the first msgFlags octet.

Source

pub const fn security_model(&self) -> i64

RFC 3412 msgSecurityModel INTEGER value.

Source

pub fn security_parameters(&self) -> &[u8]

Raw RFC 3412 msgSecurityParameters OCTET STRING bytes.

Source

pub const fn raw_security_parameters(&self) -> &SnmpRawSecurityParameters

Raw security-parameters representation with security-model metadata.

Source

pub fn usm_security_parameters( &self, ) -> Result<Option<SnmpUsmSecurityParameters>>

Decode USM security parameters when this message uses the USM model.

Source

pub fn scoped_data(&self) -> &[u8]

Raw RFC 3412 ScopedPduData TLV bytes.

Source

pub fn scoped_pdu(&self) -> Result<Option<SnmpScopedPdu>>

Decode plaintext scoped-PDU data, if this message carries plaintext.

Source

pub fn encrypted_scoped_data(&self) -> Result<Option<SnmpEncryptedScopedData>>

Decode encrypted scoped data as opaque bytes, if this message carries it.

Source

pub fn scoped_data_kind(&self) -> &'static str

Source-backed scoped-data CHOICE label.

Source

pub fn encrypted_scoped_pdu_len(&self) -> Result<Option<usize>>

Raw encryptedPDU content length, if scoped data is encrypted.

Trait Implementations§

Source§

impl Clone for SnmpV3Message

Source§

fn clone(&self) -> SnmpV3Message

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SnmpV3Message

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for SnmpV3Message

Source§

impl PartialEq for SnmpV3Message

Source§

fn eq(&self, other: &SnmpV3Message) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SnmpV3Message

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.