Enum Auth 

pub enum Auth {
    Community {
        version: CommunityVersion,
        community: String,
    },
    Usm(UsmAuth),
}

Authentication configuration for SNMP clients.

Variants

Community

Community string authentication (SNMPv1 or v2c).

Fields

version: CommunityVersion

SNMP version (V1 or V2c)

community: String

Community string

Usm(UsmAuth)

User-based Security Model (SNMPv3).

Implementations

impl Auth

pub fn v1(community: impl Into<String>) -> Self

SNMPv1 community authentication.

Creates authentication configuration for SNMPv1, which only supports community string authentication without encryption.

Example

use async_snmp::Auth;

// Create SNMPv1 authentication with "private" community
let auth = Auth::v1("private");

pub fn v2c(community: impl Into<String>) -> Self

SNMPv2c community authentication.

Creates authentication configuration for SNMPv2c, which supports community string authentication without encryption but adds GETBULK and improved error handling over SNMPv1.

Example

use async_snmp::Auth;

// Create SNMPv2c authentication with "public" community
let auth = Auth::v2c("public");

// Auth::default() is equivalent to Auth::v2c("public")
let auth = Auth::default();

pub fn usm(username: impl Into<String>) -> UsmBuilder

Start building SNMPv3 USM authentication.

Returns a builder that allows configuring authentication and privacy protocols. SNMPv3 supports three security levels:

• noAuthNoPriv: username only (no security)
• authNoPriv: username with authentication (integrity)
• authPriv: username with authentication and encryption (confidentiality)

Example

use async_snmp::{Auth, AuthProtocol, PrivProtocol};

// noAuthNoPriv: username only
let auth: Auth = Auth::usm("readonly").into();

// authNoPriv: with authentication
let auth: Auth = Auth::usm("admin")
    .auth(AuthProtocol::Sha256, "authpassword")
    .into();

// authPriv: with authentication and encryption
let auth: Auth = Auth::usm("admin")
    .auth(AuthProtocol::Sha256, "authpassword")
    .privacy(PrivProtocol::Aes128, "privpassword")
    .into();

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Auth

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

Formats the value using the given formatter.

impl Default for Auth

fn default() -> Self

Returns Auth::v2c("public").

impl Eq for Auth

impl From<UsmBuilder> for Auth

fn from(b: UsmBuilder) -> Auth

Converts to this type from the input type.

impl Hash for Auth

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Auth

fn cmp(&self, other: &Auth) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Auth

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Auth

fn partial_cmp(&self, other: &Auth) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Auth